JSON Schemas
forwardingMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
abstractMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
hashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
linkedHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
aggregationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUM", "AVERAGE", "AVERAGE_SUM_ORG_UNIT", "LAST", "LAST_AVERAGE_ORG_UNIT", "LAST_IN_PERIOD", "LAST_IN_PERIOD_AVERAGE_ORG_UNIT", "FIRST", "FIRST_AVERAGE_ORG_UNIT", "COUNT", "STDDEV", "VARIANCE", "MIN", "MAX", "NONE", "CUSTOM", "DEFAULT" ]
}
analyticsCacheTtlMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FIXED", "PROGRESSIVE" ]
}
analyticsFavoriteType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION", "REPORT_TABLE", "CHART", "MAP", "EVENT_REPORT", "EVENT_CHART", "DATASET_REPORT" ]
}
analyticsFinancialYearStartKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FINANCIAL_YEAR_APRIL", "FINANCIAL_YEAR_JULY", "FINANCIAL_YEAR_OCTOBER" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ITEMS", "DIMENSIONS", "PAGER", "ORG_UNIT_HIERARCHY", "ORG_UNIT_NAME_HIERARCHY", "ORG_UNIT_ANCESTORS" ]
}
analyticsTableHook
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"analyticsTableType" : {
"$ref" : "analyticsTableType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"phase" : {
"$ref" : "analyticsTablePhase.json"
},
"publicAccess" : {
"type" : "string"
},
"resourceTableType" : {
"$ref" : "resourceTableType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sql" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
analyticsTablePhase
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RESOURCE_TABLE_POPULATED", "ANALYTICS_TABLE_POPULATED" ]
}
analyticsTableType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_VALUE", "COMPLETENESS", "COMPLETENESS_TARGET", "ORG_UNIT_TARGET", "EVENT", "ENROLLMENT", "VALIDATION_RESULT" ]
}
dataType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NUMERIC", "BOOLEAN", "TEXT" ]
}
eventDataType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATED_VALUES", "EVENTS" ]
}
eventOutputType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT", "TRACKED_ENTITY_INSTANCE" ]
}
numberType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VALUE", "ROW_PERCENTAGE", "COLUMN_PERCENTAGE" ]
}
sortOrder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC" ]
}
userOrgUnitType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_CAPTURE", "DATA_OUTPUT", "TEI_SEARCH" ]
}
cacheType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "IN_MEMORY", "REDIS" ]
}
app
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activities" : {
"$ref" : "appActivities.json"
},
"appState" : {
"$ref" : "appStatus.json"
},
"appStorageSource" : {
"$ref" : "appStorageSource.json"
},
"appType" : {
"$ref" : "appType.json"
},
"app_hub_id" : {
"type" : "string"
},
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"baseUrl" : {
"type" : "string"
},
"bundled" : {
"type" : "boolean"
},
"core_app" : {
"type" : "boolean"
},
"default_locale" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"developer" : {
"$ref" : "appDeveloper.json"
},
"folderName" : {
"type" : "string"
},
"icons" : {
"$ref" : "appIcons.json"
},
"installs_allowed_from" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"key" : {
"type" : "string"
},
"launchUrl" : {
"type" : "string"
},
"launch_path" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"settings" : {
"$ref" : "appSettings.json"
},
"short_name" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
}
}
appActivities
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dhis" : {
"$ref" : "appDhis.json"
}
}
}
appDeveloper
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"company" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"url" : {
"type" : "string"
}
}
}
appDhis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
}
}
}
appIcons
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"128" : {
"type" : "string"
},
"16" : {
"type" : "string"
},
"48" : {
"type" : "string"
}
}
}
appSettings
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dashboardWidget" : {
"$ref" : "dashboardWidgetAppSettings.json"
}
}
}
appStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "INVALID_BUNDLED_APP_OVERRIDE", "INVALID_CORE_APP", "NAMESPACE_TAKEN", "INVALID_ZIP_FORMAT", "MISSING_MANIFEST", "INVALID_MANIFEST_JSON", "INSTALLATION_FAILED", "NOT_FOUND", "MISSING_SYSTEM_BASE_URL", "APPROVED", "PENDING", "NOT_APPROVED", "DELETION_IN_PROGRESS" ]
}
appStorageSource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LOCAL", "JCLOUDS" ]
}
appType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APP", "RESOURCE", "DASHBOARD_WIDGET", "TRACKER_DASHBOARD_WIDGET" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"hideTitle" : {
"type" : "boolean"
}
}
}
messageType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUDIT", "TRACKER_JOB", "TRACKER_SIDE_EFFECT" ]
}
serializableMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"messageType" : {
"$ref" : "messageType.json"
}
}
}
audit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"$ref" : "auditAttributes.json"
},
"auditScope" : {
"$ref" : "auditScope.json"
},
"auditType" : {
"$ref" : "auditType.json"
},
"code" : {
"type" : "string"
},
"createdAt" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"data" : { },
"klass" : {
"type" : "string"
},
"messageType" : {
"$ref" : "messageType.json"
},
"uid" : {
"type" : "string"
}
}
}
auditBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes(AuditAttributes)" : {
"$ref" : "#"
},
"auditScope(AuditScope)" : {
"$ref" : "#"
},
"auditType(AuditType)" : {
"$ref" : "#"
},
"code(String)" : {
"$ref" : "#"
},
"createdAt(LocalDateTime)" : {
"$ref" : "#"
},
"createdBy(String)" : {
"$ref" : "#"
},
"data(Object)" : {
"$ref" : "#"
},
"klass(String)" : {
"$ref" : "#"
},
"uid(String)" : {
"$ref" : "#"
}
}
}
artemisConfigData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"embedded" : {
"$ref" : "artemisEmbeddedConfig.json"
},
"host" : {
"type" : "string"
},
"mode" : {
"$ref" : "artemisMode.json"
},
"port" : {
"type" : "integer"
},
"sendAsync" : {
"type" : "boolean"
}
}
}
artemisEmbeddedConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistence" : {
"type" : "boolean"
},
"security" : {
"type" : "boolean"
}
}
}
artemisMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EMBEDDED", "NATIVE" ]
}
attribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryAttribute" : {
"type" : "boolean"
},
"categoryOptionAttribute" : {
"type" : "boolean"
},
"categoryOptionComboAttribute" : {
"type" : "boolean"
},
"categoryOptionGroupAttribute" : {
"type" : "boolean"
},
"categoryOptionGroupSetAttribute" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"constantAttribute" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementAttribute" : {
"type" : "boolean"
},
"dataElementGroupAttribute" : {
"type" : "boolean"
},
"dataElementGroupSetAttribute" : {
"type" : "boolean"
},
"dataSetAttribute" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"documentAttribute" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorAttribute" : {
"type" : "boolean"
},
"indicatorGroupAttribute" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSetAttribute" : {
"type" : "boolean"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"optionAttribute" : {
"type" : "boolean"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetAttribute" : {
"type" : "boolean"
},
"organisationUnitAttribute" : {
"type" : "boolean"
},
"organisationUnitGroupAttribute" : {
"type" : "boolean"
},
"organisationUnitGroupSetAttribute" : {
"type" : "boolean"
},
"programAttribute" : {
"type" : "boolean"
},
"programIndicatorAttribute" : {
"type" : "boolean"
},
"programStageAttribute" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"sectionAttribute" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"sqlViewAttribute" : {
"type" : "boolean"
},
"trackedEntityAttributeAttribute" : {
"type" : "boolean"
},
"trackedEntityTypeAttribute" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"unique" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userAttribute" : {
"type" : "boolean"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userGroupAttribute" : {
"type" : "boolean"
},
"validationRuleAttribute" : {
"type" : "boolean"
},
"validationRuleGroupAttribute" : {
"type" : "boolean"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
attributeValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"$ref" : "attribute.json"
},
"value" : {
"type" : "string"
}
}
}
audit_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"$ref" : "auditAttributes.json"
},
"auditScope" : {
"$ref" : "auditScope.json"
},
"auditType" : {
"$ref" : "auditType.json"
},
"code" : {
"type" : "string"
},
"createdAt" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
auditBuilder_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes(AuditAttributes)" : {
"$ref" : "#"
},
"auditScope(AuditScope)" : {
"$ref" : "#"
},
"auditType(AuditType)" : {
"$ref" : "#"
},
"code(String)" : {
"$ref" : "#"
},
"createdAt(LocalDateTime)" : {
"$ref" : "#"
},
"createdBy(String)" : {
"$ref" : "#"
},
"klass(String)" : {
"$ref" : "#"
},
"uid(String)" : {
"$ref" : "#"
}
}
}
auditAttributes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
auditScope
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "METADATA", "AGGREGATE", "TRACKER" ]
}
auditType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "READ", "UPDATE", "DELETE", "SEARCH", "SECURITY" ]
}
trackedEntityInstanceAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"accessedBy" : {
"type" : "string"
},
"auditType" : {
"$ref" : "auditType_.json"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"trackedEntityInstance" : {
"type" : "string"
}
}
}
cacheInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"burden" : {
"$ref" : "cacheBurdenInfo.json"
},
"cap" : {
"$ref" : "cacheCapInfo.json"
},
"regions" : {
"type" : "array",
"items" : {
"$ref" : "cacheGroupInfo.json"
}
},
"total" : {
"$ref" : "cacheGroupInfo.json"
}
}
}
cacheBurdenInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"averageEntrySize" : {
"type" : "integer"
},
"averageEntrySizeHumanReadable" : {
"type" : "string"
},
"entries" : {
"type" : "integer"
},
"size" : {
"type" : "integer"
},
"sizeHumanReadable" : {
"type" : "string"
},
"threshold" : {
"type" : "number"
}
}
}
cacheCapInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"capPercentage" : {
"type" : "integer"
},
"hardCapPercentage" : {
"type" : "integer"
},
"softCapPercentage" : {
"type" : "integer"
}
}
}
cacheGroupInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"averageEntrySize" : {
"type" : "integer"
},
"averageEntrySizeHumanReadable" : {
"type" : "string"
},
"burden" : {
"type" : "number"
},
"entries" : {
"type" : "integer"
},
"highBurdenEntries" : {
"type" : "integer"
},
"hits" : {
"type" : "integer"
},
"hitsMissesRatio" : {
"type" : "number"
},
"misses" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"size" : {
"type" : "integer"
},
"sizeHumanReadable" : {
"type" : "string"
}
}
}
cacheType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "IN_MEMORY", "REDIS" ]
}
region
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "analyticsResponse", "defaultObjectCache", "isDataApproved", "allConstantsCache", "inUserOuHierarchy", "isUserViewOuHierHierarchy", "inUserSearchOuHierarchy", "userCaptureOuCountThreshold", "periodIdCache", "userAccountRecoverAttempt", "userFailedLoginAttempt", "programOwner", "programTempOwner", "userIdCache", "currentUserGroupInfoCache", "userSetting", "attrOptionComboIdCache", "systemSetting", "googleAccessToken", "dataItemsPagination", "metadataAttributes", "canDataWriteCocCache", "analyticsSql", "dataElementCache", "propertyTransformerCache", "programHasRulesCache", "programRuleVariablesCache", "userGroupNameCache", "userDisplayNameCache", "programWebHookNotificationTemplateCache", "programStageWebHookNotificationTemplateCache", "pgmOrgUnitAssocCache", "catOptOrgUnitAssocCache", "apiTokensCache" ]
}
dateIntervalType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ISO8601_YEAR", "ISO8601_MONTH", "ISO8601_WEEK", "ISO8601_DAY" ]
}
dateUnitType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "WEEKLY_WEDNESDAY", "WEEKLY_THURSDAY", "WEEKLY_SATURDAY", "WEEKLY_SUNDAY", "BI_WEEKLY", "MONTHLY", "BI_MONTHLY", "QUARTERLY", "SIX_MONTHLY", "SIX_MONTHLY_APRIL", "SIX_MONTHLY_NOVEMBER", "YEARLY", "FINANCIAL_APRIL", "FINANCIAL_JULY", "FINANCIAL_OCTOBER", "FINANCIAL_NOVEMBER" ]
}
category
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryCombo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"default" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skipTotal" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"category" : {
"$ref" : "category.json"
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
}
}
}
categoryOption
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"default" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionCombo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"ignoreApproval" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryOptionGroupSet" : {
"$ref" : "categoryOptionGroupSet.json"
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
}
}
}
accessLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OPEN", "AUDITED", "PROTECTED", "CLOSED" ]
}
analyticsType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE", "EVENT" ]
}
assignedUserSelectionMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CURRENT", "PROVIDED", "NONE", "ANY" ]
}
auditType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "UPDATE", "DELETE", "READ", "SEARCH" ]
}
baseAnalyticalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
}
}
}
baseDataDimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseDimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseDimensionalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseIdentifiableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseLinkableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
}
}
}
baseNameableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
compression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "GZIP", "ZIP" ]
}
dataDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataDimensionItemType" : {
"$ref" : "dataDimensionItemType.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"dataElementOperand" : {
"$ref" : "dataElementOperand.json"
},
"indicator" : {
"$ref" : "indicator.json"
},
"programAttribute" : {
"$ref" : "programTrackedEntityAttributeDimensionItem.json"
},
"programDataElement" : {
"$ref" : "programDataElementDimensionItem.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
},
"reportingRate" : {
"$ref" : "reportingRate.json"
}
}
}
dataDimensionItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR", "DATA_ELEMENT", "DATA_ELEMENT_OPERAND", "REPORTING_RATE", "PROGRAM_INDICATOR", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "VALIDATION_RULE" ]
}
dataDimensionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DISAGGREGATION", "ATTRIBUTE" ]
}
deliveryChannel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SMS", "EMAIL", "HTTP" ]
}
dhisApiVersion
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "V28", "V29", "V30", "V31", "V32", "V33", "V34", "V35", "V36", "V37", "V38", "DEFAULT" ]
}
digitGroupSeparator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMMA", "SPACE", "NONE" ]
}
dimensionItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT", "DATA_ELEMENT_OPERAND", "INDICATOR", "REPORTING_RATE", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "PROGRAM_INDICATOR", "PERIOD", "ORGANISATION_UNIT", "CATEGORY_OPTION", "OPTION_GROUP", "DATA_ELEMENT_GROUP", "ORGANISATION_UNIT_GROUP", "CATEGORY_OPTION_GROUP" ]
}
dimensionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_X", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "PROGRAM_INDICATOR", "DATA_COLLAPSED", "CATEGORY_OPTION_COMBO", "ATTRIBUTE_OPTION_COMBO", "PERIOD", "ORGANISATION_UNIT", "CATEGORY_OPTION_GROUP_SET", "DATA_ELEMENT_GROUP_SET", "ORGANISATION_UNIT_GROUP_SET", "ORGANISATION_UNIT_GROUP", "CATEGORY", "OPTION_GROUP_SET", "VALIDATION_RULE", "STATIC", "ORGANISATION_UNIT_LEVEL" ]
}
displayDensity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMFORTABLE", "NORMAL", "COMPACT", "NONE" ]
}
displayProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORTNAME" ]
}
fallbackCoordinateFieldType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OU_GEOMETRY", "PSI_GEOMETRY" ]
}
fileTypeValueOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"type" : "object",
"properties" : {
"allowedContentTypes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"maxFileSize" : {
"type" : "integer"
},
"version" : {
"type" : "integer"
}
}
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
}
font
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ARIAL", "SANS_SERIF", "VERDANA", "ROBOTO" ]
}
fontSize
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LARGE", "NORMAL", "SMALL" ]
}
fontStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"bold" : {
"type" : "boolean"
},
"font" : {
"$ref" : "font.json"
},
"fontSize" : {
"type" : "integer"
},
"italic" : {
"type" : "boolean"
},
"textAlign" : {
"$ref" : "textAlign.json"
},
"textColor" : {
"type" : "string"
},
"underline" : {
"type" : "boolean"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"column" : {
"type" : "string"
},
"hidden" : {
"type" : "boolean"
},
"legendSet" : {
"type" : "string"
},
"meta" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"optionSet" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
hideEmptyItemStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "BEFORE_FIRST", "AFTER_LAST", "BEFORE_FIRST_AFTER_LAST", "ALL" ]
}
idSchemes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
identifiableObjects
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"additions" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
},
"deletions" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
},
"identifiableObjects" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
}
}
}
identifiableProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "UID", "UUID", "NAME", "CODE", "ATTRIBUTE" ]
}
listMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : { }
}
}
listMapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "listMap.json"
}
}
map4
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "mapMapMap.json"
}
}
mapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
mapMapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "mapMap.json"
}
}
mergeMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MERGE_ALWAYS", "MERGE_IF_NOT_NULL", "MERGE", "REPLACE", "NONE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"code" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"indicatorType" : {
"$ref" : "indicatorType.json"
},
"legendSet" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"totalAggregationType" : {
"$ref" : "totalAggregationType.json"
},
"uid" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
nameableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
notificationTemplateObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
objectStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"color" : {
"type" : "string"
},
"icon" : {
"type" : "string"
}
}
}
objects
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CONSTANT", "DATAELEMENT", "EXTENDEDDATAELEMENT", "DATAELEMENTGROUP", "DATAELEMENTGROUPSET", "INDICATORTYPE", "INDICATOR", "INDICATORGROUP", "INDICATORGROUPSET", "DATASET", "ORGANISATIONUNIT", "ORGANISATIONUNITGROUP", "ORGANISATIONUNITGROUPSET", "ORGANISATIONUNITLEVEL", "VALIDATIONRULE", "PERIOD", "DATAVALUE", "USER", "USERGROUP", "VISUALIZATION", "REPORT", "MAP", "DASHBOARD", "PROGRAM", "PROGRAMSTAGEINSTANCE", "PROGRAMINSTANCE", "TRACKEDENTITYINSTANCE", "TRACKEDENTITYATTRIBUTE" ]
}
organisationUnitSelectionMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SELECTED", "CHILDREN", "DESCENDANTS", "ACCESSIBLE", "CAPTURE", "ALL" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"nextPage" : {
"type" : "string"
},
"page" : {
"type" : "integer"
},
"pageCount" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"prevPage" : {
"type" : "string"
},
"total" : {
"type" : "integer"
}
}
}
queryOperator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EQ", "GT", "GE", "LT", "LE", "NE", "LIKE", "IN" ]
}
regressionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "LINEAR", "POLYNOMIAL", "LOESS" ]
}
reportingRate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"metric" : {
"$ref" : "reportingRateMetric.json"
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
reportingRateMetric
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "REPORTING_RATE", "REPORTING_RATE_ON_TIME", "ACTUAL_REPORTS", "ACTUAL_REPORTS_ON_TIME", "EXPECTED_REPORTS" ]
}
setMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : { }
}
}
softDeletableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
sortProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORT_NAME" ]
}
textAlign
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LEFT", "CENTER", "RIGHT" ]
}
totalAggregationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUM", "AVERAGE" ]
}
translatableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
}
}
}
valueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "LONG_TEXT", "LETTER", "PHONE_NUMBER", "EMAIL", "BOOLEAN", "TRUE_ONLY", "DATE", "DATETIME", "TIME", "NUMBER", "UNIT_INTERVAL", "PERCENTAGE", "INTEGER", "INTEGER_POSITIVE", "INTEGER_NEGATIVE", "INTEGER_ZERO_OR_POSITIVE", "TRACKER_ASSOCIATE", "USERNAME", "COORDINATE", "ORGANISATION_UNIT", "AGE", "URL", "FILE_RESOURCE", "IMAGE" ]
}
valueTypeOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"$ref" : "fileTypeValueOptions.json"
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
}
localPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
cacheStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NO_CACHE", "CACHE_1_MINUTE", "CACHE_5_MINUTES", "CACHE_10_MINUTES", "CACHE_15_MINUTES", "CACHE_30_MINUTES", "CACHE_1_HOUR", "CACHE_6AM_TOMORROW", "CACHE_TWO_WEEKS", "RESPECT_SYSTEM_SETTING" ]
}
cacheability
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PUBLIC", "PRIVATE" ]
}
appendingHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
cachingMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
mimicingHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
jsonPatch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"operations" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "addOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "add"
}
},
"required" : [ "op" ]
}, {
"$ref" : "removeOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "remove"
}
},
"required" : [ "op" ]
}, {
"$ref" : "replaceOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "replace"
}
},
"required" : [ "op" ]
} ]
}
}
}
}
weekday
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
}
configuration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"corsWhitelist" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"facilityOrgUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"facilityOrgUnitLevel" : {
"$ref" : "organisationUnitLevel.json"
},
"feedbackRecipients" : {
"$ref" : "userGroup.json"
},
"infrastructuralDataElements" : {
"$ref" : "dataElementGroup.json"
},
"infrastructuralIndicators" : {
"$ref" : "indicatorGroup.json"
},
"infrastructuralPeriodType" : {
"$ref" : "periodType.json"
},
"offlineOrganisationUnitLevel" : {
"$ref" : "organisationUnitLevel.json"
},
"selfRegistrationOrgUnit" : {
"$ref" : "organisationUnit.json"
},
"selfRegistrationRole" : {
"$ref" : "userAuthorityGroup.json"
},
"systemId" : {
"type" : "string"
}
}
}
constant
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "number"
}
}
}
dashboard
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowedFilters" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboardItems" : {
"type" : "array",
"items" : {
"$ref" : "dashboardItem.json"
}
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"itemConfig" : {
"$ref" : "itemConfig.json"
},
"itemCount" : {
"type" : "integer"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layout" : {
"$ref" : "layout.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"restrictFilters" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dashboardItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"appKey" : {
"type" : "string"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentCount" : {
"type" : "integer"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"eventChart" : {
"$ref" : "eventChart.json"
},
"eventReport" : {
"$ref" : "eventReport.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"height" : {
"type" : "integer"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretationCount" : {
"type" : "integer"
},
"interpretationLikeCount" : {
"type" : "integer"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"map" : {
"$ref" : "map.json"
},
"messages" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"shape" : {
"$ref" : "dashboardItemShape.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "dashboardItemType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
},
"width" : {
"type" : "integer"
},
"x" : {
"type" : "integer"
},
"y" : {
"type" : "integer"
}
}
}
dashboardItemShape
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NORMAL", "DOUBLE_WIDTH", "FULL_WIDTH" ]
}
dashboardItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION", "EVENT_CHART", "MAP", "EVENT_REPORT", "USERS", "REPORTS", "RESOURCES", "TEXT", "MESSAGES", "APP" ]
}
dashboardSearchResult
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"appCount" : {
"type" : "integer"
},
"apps" : {
"type" : "array",
"items" : {
"$ref" : "app.json"
}
},
"eventChartCount" : {
"type" : "integer"
},
"eventCharts" : {
"type" : "array",
"items" : {
"$ref" : "eventChart.json"
}
},
"eventReportCount" : {
"type" : "integer"
},
"eventReports" : {
"type" : "array",
"items" : {
"$ref" : "eventReport.json"
}
},
"mapCount" : {
"type" : "integer"
},
"maps" : {
"type" : "array",
"items" : {
"$ref" : "map.json"
}
},
"reportCount" : {
"type" : "integer"
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"resourceCount" : {
"type" : "integer"
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"searchCount" : {
"type" : "integer"
},
"userCount" : {
"type" : "integer"
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"visualizationCount" : {
"type" : "integer"
},
"visualizations" : {
"type" : "array",
"items" : {
"$ref" : "simpleVisualizationView.json"
}
}
}
}
column
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"index" : {
"type" : "integer"
},
"span" : {
"type" : "integer"
}
}
}
itemConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"insertHeight" : {
"type" : "integer"
},
"insertPosition" : {
"$ref" : "position.json"
}
}
}
layout
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "column.json"
}
},
"spacing" : {
"$ref" : "spacing.json"
}
}
}
position
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "START", "END" ]
}
spacing
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"row" : {
"type" : "integer"
}
}
}
dataAnalysisParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string"
},
"ou" : {
"type" : "string"
},
"standardDeviation" : {
"type" : "number"
},
"startDate" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"coc" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"de" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"ou" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startDate" : {
"type" : "string",
"format" : "date-time"
}
}
}
followupAnalysisResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followupValues" : {
"type" : "array",
"items" : {
"$ref" : "followupValue.json"
}
},
"metadata" : {
"$ref" : "followupAnalysisMetadata.json"
}
}
}
followupParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboId" : {
"type" : "integer"
},
"dataElementId" : {
"type" : "integer"
},
"followup" : {
"type" : "boolean"
},
"organisationUnitId" : {
"type" : "integer"
},
"periodId" : {
"type" : "integer"
}
}
}
followupValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"aoc" : {
"type" : "string"
},
"aocName" : {
"type" : "string"
},
"coc" : {
"type" : "string"
},
"cocName" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"de" : {
"type" : "string"
},
"deName" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"ou" : {
"type" : "string"
},
"ouName" : {
"type" : "string"
},
"ouPath" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"peEndDate" : {
"type" : "string",
"format" : "date-time"
},
"peName" : {
"type" : "string"
},
"peStartDate" : {
"type" : "string",
"format" : "date-time"
},
"peType" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
updateFollowUpForDataValuesRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followups" : {
"type" : "array",
"items" : {
"$ref" : "followupParams.json"
}
}
}
}
validationRuleExpressionDetails
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"leftSide" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"rightSide" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
validationRulesAnalysisParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"endDate" : {
"type" : "string"
},
"notification" : {
"type" : "boolean"
},
"ou" : {
"type" : "string"
},
"persist" : {
"type" : "boolean"
},
"startDate" : {
"type" : "string"
},
"vrg" : {
"type" : "string"
}
}
}
dataApproval
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalLevel" : {
"$ref" : "dataApprovalLevel.json"
}
}
}
dataApprovalAction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APPROVE", "UNAPPROVE", "ACCEPT", "UNACCEPT" ]
}
dataApprovalAndPermissions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalLevel" : {
"$ref" : "dataApprovalLevel.json"
}
}
}
dataApprovalAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"action" : {
"$ref" : "dataApprovalAction.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"creator" : {
"$ref" : "user.json"
},
"level" : {
"$ref" : "dataApprovalLevel.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"workflow" : {
"$ref" : "dataApprovalWorkflow.json"
}
}
}
dataApprovalLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionGroupSet" : {
"$ref" : "categoryOptionGroupSet.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"level" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"orgUnitLevel" : {
"type" : "integer"
},
"orgUnitLevelName" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataApprovalPermissions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"approvedAt" : {
"type" : "string",
"format" : "date-time"
},
"approvedBy" : {
"type" : "string"
},
"mayAccept" : {
"type" : "boolean"
},
"mayApprove" : {
"type" : "boolean"
},
"mayReadData" : {
"type" : "boolean"
},
"mayUnaccept" : {
"type" : "boolean"
},
"mayUnapprove" : {
"type" : "boolean"
},
"state" : {
"type" : "string"
}
}
}
dataApprovalState
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UNAPPROVABLE", "UNAPPROVED_ABOVE", "UNAPPROVED_WAITING", "UNAPPROVED_READY", "APPROVED_ABOVE", "APPROVED_HERE", "ACCEPTED_HERE" ]
}
dataApprovalStateRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ab" : {
"type" : "string"
},
"ad" : {
"type" : "string",
"format" : "date-time"
},
"ds" : {
"type" : "string"
},
"ou" : {
"type" : "string"
},
"pe" : {
"type" : "string"
}
}
}
dataApprovalStateResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"createdByUsername" : {
"type" : "string"
},
"createdDate" : {
"type" : "string",
"format" : "date-time"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"permissions" : {
"$ref" : "dataApprovalPermissions.json"
},
"state" : {
"type" : "string"
}
}
}
dataApprovalStateResponses
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalStateResponses" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalStateResponse.json"
}
}
}
}
dataApprovalWorkflow
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataApprovalLevels" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalLevel.json"
}
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
completeDataSetRegistrationRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"cc" : {
"type" : "string"
},
"cd" : {
"type" : "string",
"format" : "date-time"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"ds" : {
"type" : "string"
},
"multiOu" : {
"type" : "boolean"
},
"ou" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"sb" : {
"type" : "string"
}
}
}
dataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"commentOptionSet" : {
"$ref" : "optionSet.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"dataSetElements" : {
"type" : "array",
"items" : {
"$ref" : "dataSetElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"domainType" : {
"$ref" : "dataElementDomain.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldMask" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetValue" : {
"type" : "boolean"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
},
"valueTypeOptions" : {
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"$ref" : "fileTypeValueOptions.json"
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
},
"zeroIsSignificant" : {
"type" : "boolean"
}
}
}
dataElementDomain
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE", "TRACKER" ]
}
dataElementGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataElementGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataElementGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElementGroupSet" : {
"$ref" : "dataElementGroupSet.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
}
}
}
dataElementOperand
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
totalType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COC_ONLY", "AOC_ONLY", "COC_AND_AOC", "NONE" ]
}
dataEntryForm
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"format" : {
"type" : "integer"
},
"href" : {
"type" : "string"
},
"htmlCode" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"style" : {
"$ref" : "displayDensity.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
flattenedDataIntegrityReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElementsAssignedToDataSetsWithDifferentPeriodTypes" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsInDataSetNotInForm" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsWithoutDataSet" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dataElementsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dataSetsNotAssignedToOrganisationUnits" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"duplicatePeriods" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"indicatorsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"indicatorsWithIdenticalFormulas" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"indicatorsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"invalidCategoryCombos" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"invalidIndicatorDenominators" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidIndicatorNumerators" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidProgramIndicatorExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidProgramIndicatorFilters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidValidationRuleLeftSideExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidValidationRuleRightSideExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"organisationUnitGroupsWithoutGroupSets" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnitsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"organisationUnitsWithCyclicReferences" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnitsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"orphanedOrganisationUnits" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"programIndicatorsWithNoExpression" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"programRuleActionsWithNoDataObject" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoNotification" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoSectionId" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoStageId" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleVariablesWithNoAttribute" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleVariablesWithNoDataElement" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoAction" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoCondition" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoPriority" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"validationRulesWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
dataItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"programId" : {
"type" : "string"
},
"shortName" : {
"type" : "string"
},
"simplifiedValueType" : {
"$ref" : "valueType.json"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
dataItemBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code(String)" : {
"$ref" : "#"
},
"dimensionItemType(DimensionItemType)" : {
"$ref" : "#"
},
"displayName(String)" : {
"$ref" : "#"
},
"displayShortName(String)" : {
"$ref" : "#"
},
"id(String)" : {
"$ref" : "#"
},
"name(String)" : {
"$ref" : "#"
},
"programId(String)" : {
"$ref" : "#"
},
"shortName(String)" : {
"$ref" : "#"
},
"simplifiedValueType(ValueType)" : {
"$ref" : "#"
},
"valueType(ValueType)" : {
"$ref" : "#"
}
}
}
queryableDataItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR", "DATA_ELEMENT", "DATA_SET", "PROGRAM_INDICATOR", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE" ]
}
completeDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"completed" : {
"type" : "boolean"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"date" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"storedBy" : {
"type" : "string"
}
}
}
completeDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"closingDate" : {
"type" : "string",
"format" : "date-time"
},
"openingDate" : {
"type" : "string",
"format" : "date-time"
},
"period" : {
"$ref" : "period.json"
}
}
}
dataSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"compulsoryDataElementOperands" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"compulsoryFieldsCompleteOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementDecoration" : {
"type" : "boolean"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"dataInputPeriods" : {
"type" : "array",
"items" : {
"$ref" : "dataInputPeriod.json"
}
},
"dataSetElements" : {
"type" : "array",
"items" : {
"$ref" : "dataSetElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"expiryDays" : {
"type" : "integer"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldCombinationRequired" : {
"type" : "boolean"
},
"formName" : {
"type" : "string"
},
"formType" : {
"$ref" : "formType.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"mobile" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"noValueRequiresComment" : {
"type" : "boolean"
},
"notificationRecipients" : {
"$ref" : "userGroup.json"
},
"notifyCompletingUser" : {
"type" : "boolean"
},
"openFuturePeriods" : {
"type" : "integer"
},
"openPeriodsAfterCoEndDate" : {
"type" : "integer"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"renderAsTabs" : {
"type" : "boolean"
},
"renderHorizontally" : {
"type" : "boolean"
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "section.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipOffline" : {
"type" : "boolean"
},
"style" : {
"$ref" : "objectStyle.json"
},
"timelyDays" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validCompleteOnly" : {
"type" : "boolean"
},
"version" : {
"type" : "integer"
},
"workflow" : {
"$ref" : "dataApprovalWorkflow.json"
}
}
}
dataSetElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DEFAULT", "CUSTOM", "SECTION", "SECTION_MULTIORG" ]
}
lockException
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSet" : {
"$ref" : "dataSet.json"
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
}
}
}
section
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"description" : {
"type" : "string"
},
"disableDataElementAutoGroup" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"greyedFields" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"showColumnTotals" : {
"type" : "boolean"
},
"showRowTotals" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataSetNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_CONTACT", "USER_GROUP" ]
}
dataSetNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_CONTACT", "USER_GROUP" ]
}
dataSetNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSetNotificationTrigger" : {
"$ref" : "dataSetNotificationTrigger.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "dataSetNotificationRecipient.json"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroup" : {
"$ref" : "userGroup.json"
},
"relativeScheduledDays" : {
"type" : "integer"
},
"sendStrategy" : {
"$ref" : "sendStrategy.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataSetNotificationTemplateVariables
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NAME", "DATASET_DESCRIPTION", "COMPLETE_REG_OU", "COMPLETE_REG_PERIOD", "COMPLETE_REG_USER", "COMPLETE_REG_TIME", "COMPLETE_REG_ATT_OPT_COMBO", "CURRENT_DATE" ]
}
dataSetNotificationTemplateVariables
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NAME", "DATASET_DESCRIPTION", "COMPLETE_REG_OU", "COMPLETE_REG_PERIOD", "COMPLETE_REG_USER", "COMPLETE_REG_TIME", "COMPLETE_REG_ATT_OPT_COMBO", "CURRENT_DATE" ]
}
dataSetNotificationTrigger
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_SET_COMPLETION", "SCHEDULED_DAYS" ]
}
dbPoolTypes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "C3P0", "HIKARI" ]
}
aggregatedStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activeUsers" : {
"type" : "integer"
},
"averageDashboardViews" : {
"type" : "integer"
},
"averageEventChartViews" : {
"type" : "integer"
},
"averageEventReportViews" : {
"type" : "integer"
},
"averageMapViews" : {
"type" : "integer"
},
"averagePassiveDashboardViews" : {
"type" : "integer"
},
"averageViews" : {
"type" : "integer"
},
"averageVisualizationViews" : {
"type" : "integer"
},
"dashboardViews" : {
"type" : "integer"
},
"dataSetReportViews" : {
"type" : "integer"
},
"day" : {
"type" : "integer"
},
"eventChartViews" : {
"type" : "integer"
},
"eventReportViews" : {
"type" : "integer"
},
"mapViews" : {
"type" : "integer"
},
"month" : {
"type" : "integer"
},
"passiveDashboardViews" : {
"type" : "integer"
},
"savedDashboards" : {
"type" : "integer"
},
"savedDataValues" : {
"type" : "integer"
},
"savedEventCharts" : {
"type" : "integer"
},
"savedEventReports" : {
"type" : "integer"
},
"savedIndicators" : {
"type" : "integer"
},
"savedMaps" : {
"type" : "integer"
},
"savedVisualizations" : {
"type" : "integer"
},
"totalViews" : {
"type" : "integer"
},
"users" : {
"type" : "integer"
},
"visualizationViews" : {
"type" : "integer"
},
"week" : {
"type" : "integer"
},
"year" : {
"type" : "integer"
}
}
}
dataStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"activeUsers" : {
"type" : "integer"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboardViews" : {
"type" : "number"
},
"dataSetReportViews" : {
"type" : "number"
},
"displayName" : {
"type" : "string"
},
"eventChartViews" : {
"type" : "number"
},
"eventReportViews" : {
"type" : "number"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mapViews" : {
"type" : "number"
},
"name" : {
"type" : "string"
},
"passiveDashboardViews" : {
"type" : "number"
},
"publicAccess" : {
"type" : "string"
},
"savedDashboards" : {
"type" : "number"
},
"savedDataValues" : {
"type" : "number"
},
"savedEventCharts" : {
"type" : "number"
},
"savedEventReports" : {
"type" : "number"
},
"savedIndicators" : {
"type" : "number"
},
"savedMaps" : {
"type" : "number"
},
"savedVisualizations" : {
"type" : "number"
},
"sharing" : {
"$ref" : "sharing.json"
},
"totalViews" : {
"type" : "number"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "integer"
},
"visualizationViews" : {
"type" : "number"
}
}
}
dataStatisticsEventType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION_VIEW", "MAP_VIEW", "EVENT_REPORT_VIEW", "EVENT_CHART_VIEW", "DASHBOARD_VIEW", "PASSIVE_DASHBOARD_VIEW", "DATA_SET_REPORT_VIEW", "TOTAL_VIEW" ]
}
eventInterval
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAY", "WEEK", "MONTH", "YEAR" ]
}
favoriteStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"position" : {
"type" : "integer"
},
"views" : {
"type" : "integer"
}
}
}
dataSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activeUsers" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"dataValueCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"eventCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"objectCounts" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"userInvitations" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
}
}
}
dataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"period" : {
"$ref" : "period.json"
},
"source" : {
"$ref" : "organisationUnit.json"
},
"value" : {
"type" : "string"
}
}
}
dataValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"auditType" : {
"$ref" : "auditType_.json"
},
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"modifiedBy" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"value" : {
"type" : "string"
}
}
}
deflatedDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboName" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"dataElementId" : {
"type" : "integer"
},
"dataElementName" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"period" : {
"$ref" : "period.json"
},
"periodId" : {
"type" : "integer"
},
"sourceId" : {
"type" : "integer"
},
"sourceName" : {
"type" : "string"
},
"sourcePath" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
deduplicationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "OPEN", "INVALID", "MERGED" ]
}
mergeObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relationships" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
mergeObjectBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments(List<String>)" : {
"$ref" : "#"
},
"relationships(List<String>)" : {
"$ref" : "#"
},
"trackedEntityAttributes(List<String>)" : {
"$ref" : "#"
}
}
}
mergeStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MANUAL", "AUTO" ]
}
potentialDuplicate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"duplicate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserName" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"original" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "deduplicationStatus.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
deletedObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"deletedAt" : {
"type" : "string",
"format" : "date-time"
},
"deletedBy" : {
"type" : "string"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
document
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attachment" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentType" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"external" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
duration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "P1D", "P7D", "P14D", "P1M", "P2M", "P3M", "P6M", "P1Y" ]
}
importOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"async" : {
"type" : "boolean"
},
"datasetAllowsPeriods" : {
"type" : "boolean"
},
"dryRun" : {
"type" : "boolean"
},
"filename" : {
"type" : "string"
},
"firstRowIsHeader" : {
"type" : "boolean"
},
"force" : {
"type" : "boolean"
},
"idSchemes" : {
"$ref" : "idSchemes.json"
},
"ignoreEmptyCollection" : {
"type" : "boolean"
},
"importStrategy" : {
"$ref" : "importStrategy.json"
},
"mergeDataValues" : {
"type" : "boolean"
},
"mergeMode" : {
"$ref" : "mergeMode.json"
},
"notificationLevel" : {
"$ref" : "notificationLevel.json"
},
"preheatCache" : {
"type" : "boolean"
},
"reportMode" : {
"$ref" : "importReportMode.json"
},
"requireAttributeOptionCombo" : {
"type" : "boolean"
},
"requireCategoryOptionCombo" : {
"type" : "boolean"
},
"sharing" : {
"type" : "boolean"
},
"skipAudit" : {
"type" : "boolean"
},
"skipCache" : {
"type" : "boolean"
},
"skipExistingCheck" : {
"type" : "boolean"
},
"skipLastUpdated" : {
"type" : "boolean"
},
"skipNotifications" : {
"type" : "boolean"
},
"skipPatternValidation" : {
"type" : "boolean"
},
"strictAttributeOptionCombos" : {
"type" : "boolean"
},
"strictCategoryOptionCombos" : {
"type" : "boolean"
},
"strictDataElements" : {
"type" : "boolean"
},
"strictOrganisationUnits" : {
"type" : "boolean"
},
"strictPeriods" : {
"type" : "boolean"
}
}
}
importSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importCount" : {
"$ref" : "importCount.json"
},
"importTypeSummaries" : {
"type" : "array",
"items" : {
"$ref" : "importTypeSummary.json"
}
}
}
}
importTypeSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"conflicts" : {
"type" : "object"
},
"dataSetComplete" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enrollments" : {
"$ref" : "importSummaries.json"
},
"events" : {
"$ref" : "importSummaries.json"
},
"href" : {
"type" : "string"
},
"importConflicts" : {
"type" : "array",
"items" : {
"$ref" : "importConflict.json"
}
},
"importCount" : {
"$ref" : "importCount.json"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"lastImported" : {
"type" : "string"
},
"reference" : {
"type" : "string"
},
"relationships" : {
"$ref" : "importSummaries.json"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
},
"type" : {
"type" : "string"
}
}
}
csvImportClass
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_GROUP_MEMBERSHIP", "DATA_ELEMENT_GROUP_MEMBERSHIP", "INDICATOR_GROUP_MEMBERSHIP", "DATA_ELEMENT", "DATA_ELEMENT_GROUP", "CATEGORY_OPTION", "CATEGORY", "CATEGORY_COMBO", "CATEGORY_OPTION_GROUP", "ORGANISATION_UNIT", "ORGANISATION_UNIT_GROUP", "VALIDATION_RULE", "OPTION_SET", "OPTION_GROUP", "OPTION_GROUP_SET", "OPTION_GROUP_SET_MEMBERSHIP" ]
}
completeDataSetRegistration_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
completeDataSetRegistrations_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingJsonCompleteDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
streamingJsonCompleteDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingXmlCompleteDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
streamingXmlCompleteDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
dataValue_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingCsvDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingJsonDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingXmlDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
dataValueImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT_NOT_FOUND", "PERIOD_NOT_VALID", "ORG_UNIT_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_ACCESSIBLE", "ATTR_OPTION_COMBO_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_ACCESSIBLE", "ORG_UNIT_NOT_IN_USER_HIERARCHY", "DATA_ELEMENT_VALUE_NOT_DEFINED", "DATA_ELEMENT_VALUE_NOT_VALID", "COMMENT_NOT_VALID", "DATA_ELEMENT_INVALID_OPTION", "CATEGORY_OPTION_COMBO_NOT_SPECIFIED", "ATTR_OPTION_COMBO_NOT_SPECIFIED", "PERIOD_TYPE_NOT_VALID_FOR_DATA_ELEMENT", "DATA_ELEMENT_STRICT", "CATEGORY_OPTION_COMBO_STRICT", "ATTR_OPTION_COMBO_STRICT", "ORG_UNIT_STRICT", "STORED_BY_NOT_VALID", "PERIOD_NOT_VALID_FOR_ATTR_OPTION_COMBO", "ORG_UNIT_NOT_VALID_FOR_ATTR_OPTION_COMBO", "PERIOD_EXPIRED", "PERIOD_AFTER_DATA_ELEMENT_PERIODS", "VALUE_ALREADY_APPROVED", "PERIOD_NOT_OPEN_FOR_DATA_SET", "PERIOD_NOT_CONFORM_TO_OPEN_PERIODS", "FILE_RESOURCE_NOT_FOUND" ]
}
dataValueImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT_NOT_FOUND", "PERIOD_NOT_VALID", "ORG_UNIT_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_ACCESSIBLE", "ATTR_OPTION_COMBO_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_ACCESSIBLE", "ORG_UNIT_NOT_IN_USER_HIERARCHY", "DATA_ELEMENT_VALUE_NOT_DEFINED", "DATA_ELEMENT_VALUE_NOT_VALID", "COMMENT_NOT_VALID", "DATA_ELEMENT_INVALID_OPTION", "CATEGORY_OPTION_COMBO_NOT_SPECIFIED", "ATTR_OPTION_COMBO_NOT_SPECIFIED", "PERIOD_TYPE_NOT_VALID_FOR_DATA_ELEMENT", "DATA_ELEMENT_STRICT", "CATEGORY_OPTION_COMBO_STRICT", "ATTR_OPTION_COMBO_STRICT", "ORG_UNIT_STRICT", "STORED_BY_NOT_VALID", "PERIOD_NOT_VALID_FOR_ATTR_OPTION_COMBO", "ORG_UNIT_NOT_VALID_FOR_ATTR_OPTION_COMBO", "PERIOD_EXPIRED", "PERIOD_AFTER_DATA_ELEMENT_PERIODS", "VALUE_ALREADY_APPROVED", "PERIOD_NOT_OPEN_FOR_DATA_SET", "PERIOD_NOT_CONFORM_TO_OPEN_PERIODS", "FILE_RESOURCE_NOT_FOUND" ]
}
dataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
dataValueSetImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NOT_FOUND", "DATASET_NOT_ACCESSIBLE", "DATASET_NOT_VALID", "ORG_UNIT_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_FOUND" ]
}
dataValueSetImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NOT_FOUND", "DATASET_NOT_ACCESSIBLE", "DATASET_NOT_VALID", "ORG_UNIT_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_FOUND" ]
}
streamingCsvDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingJsonDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingXmlDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
relationshipParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"includeFrom" : {
"type" : "boolean"
},
"includeTo" : {
"type" : "boolean"
}
}
}
trackedEntityInstanceParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSynchronizationQuery" : {
"type" : "boolean"
},
"includeDeleted" : {
"type" : "boolean"
},
"includeEnrollments" : {
"type" : "boolean"
},
"includeEvents" : {
"type" : "boolean"
},
"includeProgramOwners" : {
"type" : "boolean"
},
"includeRelationships" : {
"type" : "boolean"
}
}
}
enrollment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string",
"format" : "date-time"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"enrollment" : {
"type" : "string"
},
"enrollmentDate" : {
"type" : "string",
"format" : "date-time"
},
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"incidentDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"status" : {
"$ref" : "enrollmentStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityType" : {
"type" : "string"
}
},
"required" : [ "created", "createdAtClient", "enrollment", "enrollmentDate", "incidentDate", "lastUpdated", "lastUpdatedAtClient", "program", "status", "trackedEntityInstance", "trackedEntityType" ]
}
enrollmentStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
enrollments
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments" : {
"type" : "array",
"items" : {
"$ref" : "enrollment.json"
}
}
}
}
dataValue__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"dataElement" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
event
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUser" : {
"type" : "string"
},
"assignedUserDisplayName" : {
"type" : "string"
},
"assignedUserUsername" : {
"type" : "string"
},
"attributeCategoryOptions" : {
"type" : "string"
},
"attributeOptionCombo" : {
"type" : "string"
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue__.json"
}
},
"deleted" : {
"type" : "boolean"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"enrollmentStatus" : {
"$ref" : "enrollmentStatus.json"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"programType" : {
"$ref" : "programType.json"
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"status" : {
"$ref" : "eventStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
}
},
"required" : [ "createdAtClient", "enrollment", "enrollmentStatus", "event", "eventDate", "lastUpdatedAtClient", "program", "programStage", "programType", "status" ]
}
events
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"metaData" : {
"type" : "object"
},
"pager" : {
"$ref" : "pager.json"
},
"program" : {
"type" : "string"
},
"programInstance" : {
"type" : "string"
}
}
}
note
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "userInfoSnapshot.json"
},
"note" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"storedDate" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
csvEventDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"geometry" : {
"type" : "string"
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"orgUnit" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"providedElsewhere" : {
"type" : "boolean"
},
"status" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
eventRow
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "string"
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue__.json"
}
},
"deleted" : {
"type" : "boolean"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityInstanceCreated" : {
"type" : "string"
},
"trackedEntityInstanceInactive" : {
"type" : "boolean"
},
"trackedEntityInstanceOrgUnit" : {
"type" : "string"
},
"trackedEntityInstanceOrgUnitName" : {
"type" : "string"
}
},
"required" : [ "eventDate" ]
}
eventRows
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"eventRows" : {
"type" : "array",
"items" : {
"$ref" : "eventRow.json"
}
},
"pager" : {
"$ref" : "pager.json"
}
}
}
attribute_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ownerOrgUnit" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
}
}
}
relationship
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"bidirectional" : {
"type" : "boolean"
},
"created" : {
"type" : "string"
},
"from" : {
"$ref" : "relationshipItem.json"
},
"lastUpdated" : {
"type" : "string"
},
"relationship" : {
"type" : "string"
},
"relationshipName" : {
"type" : "string"
},
"relationshipType" : {
"type" : "string"
},
"to" : {
"$ref" : "relationshipItem.json"
}
}
}
relationshipItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollment" : {
"$ref" : "enrollment.json"
},
"event" : {
"$ref" : "event.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance.json"
}
}
}
relationships
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
}
}
}
trackedEntityInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"coordinates" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"enrollments" : {
"type" : "array",
"items" : {
"$ref" : "enrollment.json"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"geometry" : {
"$ref" : "geometry.json"
},
"inactive" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"orgUnit" : {
"type" : "string"
},
"potentialDuplicate" : {
"type" : "boolean"
},
"programOwners" : {
"type" : "array",
"items" : {
"$ref" : "programOwner.json"
}
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityType" : {
"type" : "string"
}
},
"required" : [ "created", "createdAtClient", "lastUpdated", "lastUpdatedAtClient", "orgUnit", "trackedEntityInstance", "trackedEntityType" ]
}
trackedEntityInstances
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"trackedEntityInstances" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityInstance.json"
}
}
}
}
cOLUMNS
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEI_UID", "ID", "UID", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "STATUS", "GEOMETRY", "ENROLLMENTDATE", "INCIDENTDATE", "FOLLOWUP", "COMPLETED", "COMPLETEDBY", "STOREDBY", "DELETED", "PROGRAM_UID", "PROGRAM_FEATURE_TYPE", "TEI_TYPE_UID", "ORGUNIT_UID", "ORGUNIT_NAME" ]
}
cOLUMNS_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "UID", "STATUS", "EXECUTION_DATE", "DUE_DATE", "STOREDBY", "COMPLETEDBY", "COMPLETEDDATE", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "DELETED", "GEOMETRY", "TEI_UID", "ENROLLMENT_UID", "ENROLLMENT_FOLLOWUP", "ENROLLMENT_STATUS", "PROGRAM_UID", "PROGRAM_STAGE_UID", "ORGUNIT_UID", "ORGUNIT_NAME", "COC_UID", "CAT_OPTIONS" ]
}
cOLUMNS__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEI_UID", "TEI_ID", "CREATED", "UPDATED", "VALUE", "STOREDBY", "ATTR_UID", "ATTR_NAME", "ATTR_VALUE_TYPE", "ATTR_CODE", "ATTR_SKIP_SYNC" ]
}
cOLUMNS___
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UID", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "INACTIVE", "DELETED", "GEOMETRY", "TYPE_UID", "ORGUNIT_UID", "TRACKEDENTITYINSTANCEID" ]
}
importConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"object" : {
"type" : "string"
},
"objects" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"property" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
importCount
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"imported" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
importStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "WARNING", "ERROR" ]
}
importSummaries
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"importSummaries" : {
"type" : "array",
"items" : {
"$ref" : "importSummary_.json"
}
},
"imported" : {
"type" : "integer"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
},
"total" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
importSummary_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"conflicts" : {
"type" : "object"
},
"dataSetComplete" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enrollments" : {
"$ref" : "importSummaries.json"
},
"events" : {
"$ref" : "importSummaries.json"
},
"href" : {
"type" : "string"
},
"importCount" : {
"$ref" : "importCount.json"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"reference" : {
"type" : "string"
},
"relationships" : {
"$ref" : "importSummaries.json"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
}
}
}
atomicMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "NONE" ]
}
flushMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OBJECT", "AUTO" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"analyticsTableHooks" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableHook.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"categoryOptionGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"constants" : {
"type" : "array",
"items" : {
"$ref" : "constant.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dashboardItems" : {
"type" : "array",
"items" : {
"$ref" : "dashboardItem.json"
}
},
"dashboards" : {
"type" : "array",
"items" : {
"$ref" : "dashboard.json"
}
},
"dataApprovalLevels" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalLevel.json"
}
},
"dataApprovalWorkflows" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalWorkflow.json"
}
},
"dataElementGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSet.json"
}
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"dataElementOperands" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"dataEntryForms" : {
"type" : "array",
"items" : {
"$ref" : "dataEntryForm.json"
}
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"dimensions" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"documents" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"eventCharts" : {
"type" : "array",
"items" : {
"$ref" : "eventChart.json"
}
},
"eventReports" : {
"type" : "array",
"items" : {
"$ref" : "eventReport.json"
}
},
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"externalMapLayers" : {
"type" : "array",
"items" : {
"$ref" : "externalMapLayer.json"
}
},
"indicatorGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroupSet.json"
}
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"indicatorTypes" : {
"type" : "array",
"items" : {
"$ref" : "indicatorType.json"
}
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "nameableObject.json"
}
},
"jobConfigurations" : {
"type" : "array",
"items" : {
"$ref" : "jobConfiguration.json"
}
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"mapViews" : {
"type" : "array",
"items" : {
"$ref" : "mapView.json"
}
},
"maps" : {
"type" : "array",
"items" : {
"$ref" : "map.json"
}
},
"metadataVersions" : {
"type" : "array",
"items" : {
"$ref" : "metadataVersion.json"
}
},
"optionGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "optionGroupSet.json"
}
},
"optionGroups" : {
"type" : "array",
"items" : {
"$ref" : "optionGroup.json"
}
},
"optionSets" : {
"type" : "array",
"items" : {
"$ref" : "optionSet.json"
}
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"organisationUnitGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSet.json"
}
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitLevel.json"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"predictorGroups" : {
"type" : "array",
"items" : {
"$ref" : "predictorGroup.json"
}
},
"predictors" : {
"type" : "array",
"items" : {
"$ref" : "predictor.json"
}
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programNotificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"programRuleActions" : {
"type" : "array",
"items" : {
"$ref" : "programRuleAction.json"
}
},
"programRuleVariables" : {
"type" : "array",
"items" : {
"$ref" : "programRuleVariable.json"
}
},
"programRules" : {
"type" : "array",
"items" : {
"$ref" : "programRule.json"
}
},
"programStageSections" : {
"type" : "array",
"items" : {
"$ref" : "programStageSection.json"
}
},
"programStages" : {
"type" : "array",
"items" : {
"$ref" : "programStage.json"
}
},
"programs" : {
"type" : "array",
"items" : {
"$ref" : "program.json"
}
},
"relationshipTypes" : {
"type" : "array",
"items" : {
"$ref" : "relationshipType.json"
}
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"schemas" : {
"type" : "array",
"items" : {
"$ref" : "schema.json"
}
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "section.json"
}
},
"sqlViews" : {
"type" : "array",
"items" : {
"$ref" : "sqlView.json"
}
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttribute.json"
}
},
"trackedEntityTypes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityType.json"
}
},
"userGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"validationNotificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "validationNotificationTemplate.json"
}
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"$ref" : "validationRuleGroup.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"atomicMode" : {
"$ref" : "atomicMode.json"
},
"csvImportClass" : {
"$ref" : "csvImportClass.json"
},
"filename" : {
"type" : "string"
},
"firstRowIsHeader" : {
"type" : "boolean"
},
"flushMode" : {
"$ref" : "flushMode.json"
},
"identifier" : {
"$ref" : "preheatIdentifier.json"
},
"importMode" : {
"$ref" : "objectBundleMode.json"
},
"importReportMode" : {
"$ref" : "importReportMode.json"
},
"importStrategy" : {
"$ref" : "importStrategy.json"
},
"mergeMode" : {
"$ref" : "mergeMode.json"
},
"metadataSyncImport" : {
"type" : "boolean"
},
"preheatMode" : {
"$ref" : "preheatMode.json"
},
"skipSharing" : {
"type" : "boolean"
},
"skipTranslation" : {
"type" : "boolean"
},
"skipValidation" : {
"type" : "boolean"
},
"userOverrideMode" : {
"$ref" : "userOverrideMode.json"
},
"username" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"metadata" : {
"type" : "string"
}
}
}
userOverrideMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "CURRENT", "SELECTED" ]
}
importReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importParams" : {
"$ref" : "metadataImportParams.json"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
},
"typeReports" : {
"type" : "array",
"items" : {
"$ref" : "typeReport.json"
}
}
}
}
importReportMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FULL", "ERRORS", "ERRORS_NOT_OWNER", "DEBUG" ]
}
objectBundleMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMMIT", "VALIDATE" ]
}
objectBundleStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATED", "VALIDATED", "COMMITTED" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importReport" : {
"$ref" : "importReport.json"
},
"importSummary" : {
"$ref" : "importSummary.json"
},
"metadataVersion" : {
"$ref" : "metadataVersion.json"
}
}
}
jobConfigurationWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"jobParameters" : {
"$ref" : "jobParameters.json"
},
"jobStatus" : {
"$ref" : "jobStatus.json"
},
"jobType" : {
"$ref" : "jobType.json"
},
"name" : {
"type" : "string"
},
"relativeNotifierEndpoint" : {
"type" : "string"
}
}
}
syncEndpoint
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCES", "ENROLLMENTS", "EVENTS", "COMPLETE_DATA_SET_REGISTRATIONS", "DATA_VALUE_SETS" ]
}
synchronizationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "FAILURE" ]
}
availabilityStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"available" : {
"type" : "boolean"
},
"message" : {
"type" : "string"
},
"statusCode" : {
"type" : "integer"
},
"statusPhrase" : {
"type" : "string"
}
}
}
abstractWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"responseType" : {
"type" : "string"
}
}
}
descriptiveWebMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "integer"
},
"description" : {
"type" : "string"
},
"devMessage" : {
"type" : "string"
},
"errorCode" : {
"$ref" : "errorCode.json"
},
"httpStatus" : {
"type" : "string"
},
"httpStatusCode" : {
"type" : "integer"
},
"message" : {
"type" : "string"
},
"response" : {
"$ref" : "webMessageResponse.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
webMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "integer"
},
"devMessage" : {
"type" : "string"
},
"errorCode" : {
"$ref" : "errorCode.json"
},
"httpStatus" : {
"type" : "string"
},
"httpStatusCode" : {
"type" : "integer"
},
"message" : {
"type" : "string"
},
"response" : {
"$ref" : "webMessageResponse.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
webMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
errorReportsWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"responseType" : {
"type" : "string"
}
}
}
fileResourceWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fileResource" : {
"$ref" : "fileResource.json"
},
"responseType" : {
"type" : "string"
}
}
}
importCountWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "integer"
},
"deleted" : {
"type" : "integer"
},
"responseType" : {
"type" : "string"
},
"updated" : {
"type" : "integer"
}
}
}
importReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"responseType" : {
"type" : "string"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
},
"typeReports" : {
"type" : "array",
"items" : {
"$ref" : "typeReport.json"
}
}
}
}
objectReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"klass" : {
"type" : "string"
},
"responseType" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
typeReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"objectReports" : {
"type" : "array",
"items" : {
"$ref" : "objectReport.json"
}
},
"responseType" : {
"type" : "string"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
email
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"sender" : {
"$ref" : "user.json"
},
"subject" : {
"type" : "string"
},
"text" : {
"type" : "string"
}
}
}
emailResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SENT", "FAILED", "ABORTED", "NOT_CONFIGURED", "HOST_CONFIG_NOT_FOUND" ]
}
encryptionStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "MISSING_JCE_POLICY", "MISSING_ENCRYPTION_PASSWORD", "ENCRYPTION_PASSWORD_TOO_SHORT" ]
}
eventStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "VISITED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
baseChart
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"baseLineLabel" : {
"type" : "string"
},
"baseLineValue" : {
"type" : "number"
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideLegend" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendDisplayStrategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer"
},
"rangeAxisLabel" : {
"type" : "string"
},
"rangeAxisMaxValue" : {
"type" : "number"
},
"rangeAxisMinValue" : {
"type" : "number"
},
"rangeAxisSteps" : {
"type" : "integer"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string"
},
"targetLineValue" : {
"type" : "number"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
eventChart
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValueDimension" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"baseLineLabel" : {
"type" : "string"
},
"baseLineValue" : {
"type" : "number"
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"collapseDataDimensions" : {
"type" : "boolean"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"dataElementValueDimension" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideLegend" : {
"type" : "boolean"
},
"hideNaData" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendDisplayStrategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outputType" : {
"$ref" : "eventOutputType.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer"
},
"rangeAxisLabel" : {
"type" : "string"
},
"rangeAxisMaxValue" : {
"type" : "number"
},
"rangeAxisMinValue" : {
"type" : "number"
},
"rangeAxisSteps" : {
"type" : "integer"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string"
},
"targetLineValue" : {
"type" : "number"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"value" : {
"$ref" : "dimensionalItemObject.json"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
eventDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
eventReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValueDimension" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"colSubTotals" : {
"type" : "boolean"
},
"colTotals" : {
"type" : "boolean"
},
"collapseDataDimensions" : {
"type" : "boolean"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"dataElementValueDimension" : {
"$ref" : "dataElement.json"
},
"dataType" : {
"$ref" : "eventDataType.json"
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDensity" : {
"$ref" : "displayDensity.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"fontSize" : {
"$ref" : "fontSize.json"
},
"formName" : {
"type" : "string"
},
"hideEmptyRows" : {
"type" : "boolean"
},
"hideNaData" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outputType" : {
"$ref" : "eventOutputType.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rowSubTotals" : {
"type" : "boolean"
},
"rowTotals" : {
"type" : "boolean"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showDimensionLabels" : {
"type" : "boolean"
},
"showHierarchy" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"value" : {
"$ref" : "dimensionalItemObject.json"
}
}
}
expression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"missingValueStrategy" : {
"$ref" : "missingValueStrategy.json"
},
"slidingWindow" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
}
}
}
expressionValidationOutcome
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VALID", "EXPRESSION_IS_EMPTY", "DIMENSIONAL_ITEM_OBJECT_DOES_NOT_EXIST", "CONSTANT_DOES_NOT_EXIST", "ORG_UNIT_GROUP_DOES_NOT_EXIST", "EXPRESSION_IS_NOT_WELL_FORMED" ]
}
missingValueStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SKIP_IF_ANY_VALUE_MISSING", "SKIP_IF_ALL_VALUES_MISSING", "NEVER_SKIP" ]
}
operator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "equal_to", "not_equal_to", "greater_than", "greater_than_or_equal_to", "less_than", "less_than_or_equal_to", "compulsory_pair", "exclusive_pair" ]
}
parseType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR_EXPRESSION", "VALIDATION_RULE_EXPRESSION", "PREDICTOR_EXPRESSION", "PREDICTOR_SKIP_TEST", "SIMPLE_TEST" ]
}
configurationKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SYSTEM_READ_ONLY_MODE", "SYSTEM_SESSION_TIMEOUT", "SYSTEM_MONITORING_URL", "SYSTEM_MONITORING_USERNAME", "SYSTEM_MONITORING_PASSWORD", "SYSTEM_SQL_VIEW_TABLE_PROTECTION", "SYSTEM_PROGRAM_RULE_SERVER_EXECUTION", "SYSTEM_CACHE_MAX_SIZE_FACTOR", "SYSTEM_CACHE_CAP_PERCENTAGE", "NODE_ID", "ENCRYPTION_PASSWORD", "CONNECTION_DIALECT", "CONNECTION_DRIVER_CLASS", "CONNECTION_URL", "CONNECTION_USERNAME", "CONNECTION_PASSWORD", "CONNECTION_SCHEMA", "CONNECTION_POOL_MAX_SIZE", "CONNECTION_POOL_MIN_SIZE", "CONNECTION_POOL_INITIAL_SIZE", "CONNECTION_POOL_ACQUIRE_INCR", "CONNECTION_POOL_MAX_IDLE_TIME", "CONNECTION_POOL_MAX_IDLE_TIME_EXCESS_CON", "CONNECTION_POOL_IDLE_CON_TEST_PERIOD", "CONNECTION_POOL_TEST_ON_CHECKOUT", "CONNECTION_POOL_TEST_ON_CHECKIN", "CONNECTION_POOL_TIMEOUT", "CONNECTION_POOL_VALIDATION_TIMEOUT", "CONNECTION_POOL_NUM_THREADS", "CONNECTION_POOL_TEST_QUERY", "LDAP_URL", "LDAP_MANAGER_DN", "LDAP_MANAGER_PASSWORD", "LDAP_SEARCH_BASE", "LDAP_SEARCH_FILTER", "FILESTORE_PROVIDER", "FILESTORE_CONTAINER", "FILESTORE_LOCATION", "FILESTORE_IDENTITY", "FILESTORE_SECRET", "GOOGLE_SERVICE_ACCOUNT_CLIENT_ID", "META_DATA_SYNC_RETRY", "META_DATA_SYNC_RETRY_TIME_FREQUENCY_MILLISEC", "CLUSTER_HOSTNAME", "CLUSTER_MEMBERS", "CLUSTER_CACHE_PORT", "CLUSTER_CACHE_REMOTE_OBJECT_PORT", "REDIS_HOST", "REDIS_PORT", "REDIS_PASSWORD", "REDIS_ENABLED", "REDIS_USE_SSL", "FLYWAY_OUT_OF_ORDER_MIGRATION", "FLYWAY_REPAIR_BEFORE_MIGRATION", "PROGRAM_TEMPORARY_OWNERSHIP_TIMEOUT", "LEADER_TIME_TO_LIVE", "ANALYTICS_CACHE_EXPIRATION", "ARTEMIS_MODE", "ARTEMIS_HOST", "ARTEMIS_PORT", "ARTEMIS_USERNAME", "ARTEMIS_PASSWORD", "ARTEMIS_EMBEDDED_SECURITY", "ARTEMIS_EMBEDDED_PERSISTENCE", "ARTEMIS_EMBEDDED_THREADS", "LOGGING_FILE_MAX_SIZE", "LOGGING_FILE_MAX_ARCHIVES", "LOGGING_REQUEST_ID_HASH", "LOGGING_REQUEST_ID_ENABLED", "LOGGING_REQUEST_ID_MAX_SIZE", "SERVER_BASE_URL", "SERVER_HTTPS", "MONITORING_PROVIDER", "MONITORING_API_ENABLED", "MONITORING_JVM_ENABLED", "MONITORING_DBPOOL_ENABLED", "MONITORING_HIBERNATE_ENABLED", "MONITORING_UPTIME_ENABLED", "MONITORING_CPU_ENABLED", "APPHUB_BASE_URL", "APPHUB_API_URL", "CHANGELOG_AGGREGATE", "CHANGELOG_TRACKER", "AUDIT_USE_INMEMORY_QUEUE_ENABLED", "AUDIT_USE_IN_MEMORY_QUEUE_ENABLED", "AUDIT_LOGGER", "AUDIT_DATABASE", "AUDIT_METADATA_MATRIX", "AUDIT_TRACKER_MATRIX", "AUDIT_AGGREGATE_MATRIX", "OIDC_OAUTH2_LOGIN_ENABLED", "OIDC_LOGOUT_REDIRECT_URL", "OIDC_PROVIDER_GOOGLE_CLIENT_ID", "OIDC_PROVIDER_GOOGLE_CLIENT_SECRET", "OIDC_PROVIDER_GOOGLE_MAPPING_CLAIM", "OIDC_PROVIDER_GOOGLE_REDIRECT_URI", "OIDC_PROVIDER_WSO2_CLIENT_ID", "OIDC_PROVIDER_WSO2_CLIENT_SECRET", "OIDC_PROVIDER_WSO2_MAPPING_CLAIM", "OIDC_PROVIDER_WSO2_SERVER_URL", "OIDC_PROVIDER_WSO2_REDIRECT_URI", "OIDC_PROVIDER_WSO2_DISPLAY_ALIAS", "OIDC_PROVIDER_WSO2_ENABLE_LOGOUT", "SLOW_QUERY_LOGGING_THRESHOLD_TIME_MS", "ENABLE_QUERY_LOGGING", "METHOD_QUERY_LOGGING_ENABLED", "ELAPSED_TIME_QUERY_LOGGING_ENABLED", "DB_POOL_TYPE", "ACTIVE_READ_REPLICAS", "AUDIT_ENABLED", "TRACKER_IMPORT_PREHEAT_CACHE_ENABLED", "ENABLE_OAUTH2_AUTHORIZATION_SERVER", "ENABLE_JWT_OIDC_TOKEN_AUTHENTICATION", "DEBEZIUM_ENABLED", "DEBEZIUM_CONNECTION_USERNAME", "DEBEZIUM_CONNECTION_PASSWORD", "DEBEZIUM_DB_HOSTNAME", "DEBEZIUM_DB_PORT", "DEBEZIUM_DB_NAME", "DEBEZIUM_SLOT_NAME", "DEBEZIUM_EXCLUDE_LIST", "DEBEZIUM_SHUTDOWN_ON_CONNECTOR_STOP", "ENABLE_API_TOKEN_AUTHENTICATION" ]
}
googleAccessToken
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access_token" : {
"type" : "string"
},
"client_id" : {
"type" : "string"
},
"expires_in" : {
"type" : "integer"
}
}
}
errorCode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "E1000", "E1001", "E1002", "E1100", "E1101", "E1102", "E1103", "E1104", "E1105", "E1106", "E1107", "E1500", "E1501", "E1502", "E1503", "E1504", "E1510", "E1511", "E1512", "E1513", "E1514", "E1515", "E1516", "E1520", "E1521", "E1522", "E1523", "E2000", "E2001", "E2002", "E2003", "E2004", "E2005", "E2006", "E2007", "E2008", "E2009", "E2010", "E2011", "E2012", "E2013", "E2014", "E2015", "E2016", "E2017", "E2018", "E2019", "E2020", "E2021", "E2022", "E2023", "E2024", "E2025", "E2026", "E2027", "E2028", "E2029", "E2030", "E2031", "E2032", "E2033", "E2034", "E2035", "E2036", "E2037", "E2038", "E2200", "E2201", "E2202", "E2203", "E2204", "E2205", "E2206", "E2207", "E2208", "E2300", "E2301", "E3000", "E3001", "E3002", "E3003", "E3004", "E3005", "E3006", "E3008", "E3009", "E3010", "E3011", "E3012", "E3013", "E3014", "E3015", "E3016", "E3017", "E3018", "E4000", "E4001", "E4002", "E4003", "E4004", "E4005", "E4006", "E4007", "E4008", "E4009", "E4010", "E4011", "E4012", "E4013", "E4014", "E4015", "E4016", "E4017", "E4018", "E4019", "E4020", "E4021", "E4022", "E4023", "E4024", "E4025", "E4026", "E4027", "E4028", "E4029", "E4030", "E4033", "E4034", "E4035", "E4036", "E4037", "E4038", "E4039", "E4040", "E4041", "E4042", "E4043", "E4044", "E4045", "E4046", "E4047", "E4048", "E4049", "E4050", "E4051", "E4052", "E4053", "E4300", "E4301", "E4302", "E4303", "E4304", "E4305", "E4306", "E4307", "E4308", "E4309", "E4310", "E4311", "E4312", "E4313", "E5000", "E5001", "E5002", "E5003", "E5004", "E5005", "E5006", "E6000", "E6001", "E6100", "E6101", "E6200", "E7000", "E7003", "E7004", "E7005", "E7006", "E7007", "E7010", "E7100", "E7101", "E7102", "E7103", "E7104", "E7105", "E7106", "E7107", "E7108", "E7109", "E7110", "E7111", "E7112", "E7113", "E7114", "E7115", "E7116", "E7117", "E7118", "E7119", "E7120", "E7121", "E7122", "E7123", "E7124", "E7125", "E7126", "E7127", "E7128", "E7129", "E7130", "E7131", "E7132", "E7133", "E7200", "E7201", "E7202", "E7203", "E7204", "E7205", "E7206", "E7207", "E7208", "E7209", "E7210", "E7211", "E7212", "E7213", "E7214", "E7215", "E7216", "E7217", "E7218", "E7219", "E7220", "E7221", "E7222", "E7223", "E7224", "E7225", "E7226", "E7227", "E7228", "E7229", "E7300", "E7301", "E7400", "E7500", "E7501", "E7502", "E7503", "E7600", "E7601", "E7602", "E7603", "E7604", "E7610", "E7611", "E7612", "E7613", "E7614", "E7615", "E7616", "E7617", "E7618", "E7619", "E7620", "E7621", "E7630", "E7631", "E7632", "E7633", "E7634", "E7635", "E7636", "E7637", "E7638", "E7639", "E7640", "E7641", "E7642", "E7643", "E7644", "E7645" ]
}
errorReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"errorKlass" : {
"type" : "string"
},
"errorProperties" : {
"type" : "array",
"items" : { }
},
"errorProperty" : {
"type" : "string"
},
"mainId" : {
"type" : "string"
},
"mainKlass" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"value" : { }
}
}
objectReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"displayName" : {
"type" : "string"
},
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"index" : {
"type" : "integer"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
stats
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "integer"
},
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"total" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
status
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "WARNING", "ERROR" ]
}
typeReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"klass" : {
"type" : "string"
},
"objectReports" : {
"type" : "array",
"items" : {
"$ref" : "objectReport.json"
}
},
"stats" : {
"$ref" : "stats.json"
}
}
}
defaults
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCLUDE", "EXCLUDE" ]
}
fieldMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
externalFileResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accessToken" : {
"type" : "string"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"expires" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fileResource" : {
"$ref" : "fileResource.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
fileResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentLength" : {
"type" : "integer"
},
"contentMd5" : {
"type" : "string"
},
"contentType" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"domain" : {
"$ref" : "fileResourceDomain.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hasMultipleStorageFiles" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"storageStatus" : {
"$ref" : "fileResourceStorageStatus.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
fileResourceDomain
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_VALUE", "PUSH_ANALYSIS", "DOCUMENT", "MESSAGE_ATTACHMENT", "USER_AVATAR", "ORG_UNIT" ]
}
fileResourceRetentionStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "THREE_MONTHS", "ONE_YEAR", "FOREVER" ]
}
fileResourceStorageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "PENDING", "FAILED", "STORED" ]
}
imageFileDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SMALL", "MEDIUM", "LARGE", "ORIGINAL" ]
}
simpleImageResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"images" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
gistAutoType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "XL", "L", "M", "S", "XS" ]
}
idObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"nextPage" : {
"type" : "string"
},
"page" : {
"type" : "integer"
},
"pageCount" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"prevPage" : {
"type" : "string"
},
"total" : {
"type" : "integer"
}
}
}
gistQuery
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absoluteUrls" : {
"type" : "boolean"
},
"anyFilter" : {
"type" : "boolean"
},
"auto" : {
"$ref" : "gistAutoType.json"
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "field.json"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "filter.json"
}
},
"headless" : {
"type" : "boolean"
},
"inverse" : {
"type" : "boolean"
},
"orders" : {
"type" : "array",
"items" : {
"$ref" : "order.json"
}
},
"pageOffset" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"total" : {
"type" : "boolean"
},
"translate" : {
"type" : "boolean"
}
}
}
comparison
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NULL", "NOT_NULL", "EQ", "IEQ", "NE", "LT", "LE", "GT", "GE", "IN", "NOT_IN", "EMPTY", "NOT_EMPTY", "LIKE", "NOT_LIKE", "STARTS_LIKE", "NOT_STARTS_LIKE", "ENDS_LIKE", "NOT_ENDS_LIKE", "ILIKE", "NOT_ILIKE", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "CAN_READ", "CAN_WRITE", "CAN_DATA_READ", "CAN_DATA_WRITE", "CAN_ACCESS" ]
}
direction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC" ]
}
field
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"alias" : {
"type" : "string"
},
"attribute" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"propertyPath" : {
"type" : "string"
},
"transformation" : {
"$ref" : "transform.json"
},
"transformationArgument" : {
"type" : "string"
},
"translate" : {
"type" : "boolean"
}
}
}
fieldBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"alias(String)" : {
"$ref" : "#"
},
"attribute(boolean)" : {
"$ref" : "#"
},
"propertyPath(String)" : {
"$ref" : "#"
},
"transformation(Transform)" : {
"$ref" : "#"
},
"transformationArgument(String)" : {
"$ref" : "#"
},
"translate(boolean)" : {
"$ref" : "#"
}
}
}
filter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "boolean"
},
"group" : {
"type" : "integer"
},
"operator" : {
"$ref" : "comparison.json"
},
"propertyPath" : {
"type" : "string"
},
"value" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
gistQueryBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absoluteUrls(boolean)" : {
"$ref" : "#"
},
"anyFilter(boolean)" : {
"$ref" : "#"
},
"auto(GistAutoType)" : {
"$ref" : "#"
},
"fields(List<Field>)" : {
"$ref" : "#"
},
"filters(List<Filter>)" : {
"$ref" : "#"
},
"headless(boolean)" : {
"$ref" : "#"
},
"inverse(boolean)" : {
"$ref" : "#"
},
"orders(List<Order>)" : {
"$ref" : "#"
},
"pageOffset(int)" : {
"$ref" : "#"
},
"pageSize(int)" : {
"$ref" : "#"
},
"total(boolean)" : {
"$ref" : "#"
},
"translate(boolean)" : {
"$ref" : "#"
}
}
}
order
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"direction" : {
"$ref" : "direction.json"
},
"propertyPath" : {
"type" : "string"
}
}
}
orderBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"direction(Direction)" : {
"$ref" : "#"
},
"propertyPath(String)" : {
"$ref" : "#"
}
}
}
i18nLocale
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"locale" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
icon
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "_2G", "_3G", "_4X4", "AGRICULTURE", "AGRICULTURE_WORKER", "ALERT", "ALERT_CIRCLE", "ALERT_TRIANGLE", "AMBULANCE", "AMBULATORY_CLINIC", "ANCV", "BABY_FEMALE_0203M", "BABY_FEMALE_0306M", "BABY_FEMALE_0609M", "BABY_MALE_0203M", "BABY_MALE_0306M", "BABY_MALE_0609M", "BASIC_MOTORCYCLE", "BIKE", "BILLS", "BLISTER_PILLS_OVAL_X1", "BLISTER_PILLS_OVAL_X14", "BLISTER_PILLS_OVAL_X16", "BLISTER_PILLS_OVAL_X4", "BLISTER_PILLS_ROUND_X1", "BLISTER_PILLS_ROUND_X14", "BLISTER_PILLS_ROUND_X16", "BLISTER_PILLS_ROUND_X4", "BLOOD_A_N", "BLOOD_A_P", "BLOOD_AB_N", "BLOOD_AB_P", "BLOOD_B_N", "BLOOD_B_P", "BLOOD_O_N", "BLOOD_O_P", "BLOOD_PRESSURE", "BLOOD_PRESSURE_2", "BLOOD_PRESSURE_MONITOR", "BLOOD_RH_N", "BLOOD_RH_P", "BOY_0105Y", "BOY_1015Y", "BREEDING_SITES", "CALENDAR", "CARDIOGRAM", "CARDIOGRAM_E", "CERVICAL_CANCER", "CHILD_CARE", "CHILD_PROGRAM", "CHILLS", "CHOLERA", "CHURCH", "CIRCLE_LARGE", "CIRCLE_MEDIUM", "CIRCLE_SMALL", "CITY", "CITY_WORKER", "CLEAN_HANDS", "CLINICAL_A", "CLINICAL_F", "CLINICAL_FE", "COINS", "COLD_CHAIN", "COMMUNICATION", "CONE_TEST_ON_NETS", "CONE_TEST_ON_WALLS", "CONSTRUCTION", "CONSTRUCTION_WORKER", "CONTACT_SUPPORT", "CONTRACEPTIVE_DIAPHRAGM", "CONTRACEPTIVE_INJECTION", "CONTRACEPTIVE_PATCH", "CONTRACEPTIVE_VOUCHER", "COPPER_IUD", "COUGHING", "CREDIT_CARD", "CROSS_COUNTRY_MOTORCYCLE", "DEFAULT", "DHIS2_LOGO", "DIARRHEA", "DISCRIMINATING_CONCENTRATION_BIOASSAYS", "DOCTOR", "DOMESTIC_WORKER", "DONKEY", "DRONE", "ECO_CARE", "ELDERLY", "ELECTRICITY", "EMERGENCY_POST", "EXPECTORATE", "FACTORY_WORKER", "FAMILY_PLANNING", "FEMALE_AND_MALE", "FEMALE_CONDOM", "FEMALE_SEX_WORKER", "FETUS", "FEVER", "FEVER_2", "FEVER_CHILLS", "FOREST", "FOREST_PERSONS", "FORUM", "GIRL_0105Y", "GIRL_1015Y", "GROUP_DISCUSSION_MEETING", "GROUP_DISCUSSION_MEETINGX3", "HAPPY", "HAZARDOUS", "HEADACHE", "HEALTH_WORKER", "HEALTH_WORKER_FORM", "HEART", "HEART_CARDIOGRAM", "HELICOPTER", "HIGH_BARS", "HIGH_LEVEL", "HIV_IND", "HIV_NEG", "HIV_POS", "HIV_SELF_TEST", "HOME", "HORMONAL_RING", "HOSPITAL", "HOSPITALIZED", "HOT_MEAL", "HPV", "I_CERTIFICATE_PAPER", "I_DOCUMENTS_ACCEPTED", "I_DOCUMENTS_DENIED", "I_EXAM_MULTIPLE_CHOICE", "I_EXAM_QUALIFICATION", "I_GROUPS_PERSPECTIVE_CROWD", "I_NOTE_ACTION", "I_SCHEDULE_SCHOOL_DATE_TIME", "I_TRAINING_CLASS", "I_UTENSILS", "IMM", "IMPLANT", "INFO", "INFORMATION_CAMPAIGN", "INPATIENT", "INSECTICIDE_RESISTANCE", "INTENSITY_CONCENTRATION_BIOASSAYS", "IUD", "JUSTICE", "LACTATION", "LETRINA", "LLIN", "LOW_BARS", "LOW_LEVEL", "MACHINERY", "MAGNIFYING_GLASS", "MALARIA_MIXED_MICROSCOPE", "MALARIA_NEGATIVE_MICROSCOPE", "MALARIA_OUTBREAK", "MALARIA_PF_MICROSCOPE", "MALARIA_PV_MICROSCOPE", "MALARIA_TESTING", "MALE_AND_FEMALE", "MALE_CONDOM", "MALE_SEX_WORKER", "MAN", "MARKET_STALL", "MASK", "MEASLES", "MEDICINES", "MEDIUM_BARS", "MEDIUM_LEVEL", "MEGAPHONE", "MENTAL_DISORDERS", "MICROSCOPE", "MILITARY_WORKER", "MINER_WORKER", "MOBILE_CLINIC", "MONEY_BAG", "MOSQUITO", "MOSQUITO_COLLECTION", "MSM", "NAUSEA", "NEGATIVE", "NETWORK_4G", "NETWORK_5G", "NEUROLOGY", "NEUTRAL", "NO", "NOT_OK", "NURSE", "OBSERVATION", "ODONTOLOGY", "ODONTOLOGY_IMPLANT", "OFFICER", "OK", "OLD_MAN", "OLD_WOMAN", "ORAL_CONTRACEPTION_PILLSX21", "ORAL_CONTRACEPTION_PILLSX28", "OUTPATIENT", "OVERWEIGHT", "PALM_BRANCHES_ROOF", "PAVE_ROAD", "PEACE", "PEOPLE", "PERSON", "PHONE", "PILL_1", "PILLS_2", "PILLS_3", "PILLS_4", "PLANTATION_WORKER", "POLYGON", "POSITIVE", "PREGNANT", "PREGNANT_0812W", "PREGNANT_2426W", "PREGNANT_32W", "PREGNANT_3638W", "PRISONER", "PROPER_ROOF", "PROVIDER_FST", "PWID", "QUESTION", "QUESTION_CIRCLE", "QUESTION_TRIANGLE", "RDT_RESULT_INVALID", "RDT_RESULT_MIXED", "RDT_RESULT_MIXED_INVALID", "RDT_RESULT_MIXED_INVALID_RECTANGULAR", "RDT_RESULT_MIXED_RECTANGULAR", "RDT_RESULT_NEG", "RDT_RESULT_NEG_INVALID", "RDT_RESULT_NEG_INVALID_RECTANGULAR", "RDT_RESULT_NEG_RECTANGULAR", "RDT_RESULT_NEGATIVE", "RDT_RESULT_NO_TEST", "RDT_RESULT_OUT_STOCK", "RDT_RESULT_PF", "RDT_RESULT_PF_INVALID", "RDT_RESULT_PF_INVALID_RECTANGULAR", "RDT_RESULT_PF_RECTANGULAR", "RDT_RESULT_POSITIVE", "RDT_RESULT_PV", "RDT_RESULT_PV_INVALID", "RDT_RESULT_PV_INVALID_RECTANGULAR", "RDT_RESULT_PV_RECTANGULAR", "REFERRAL", "REFUSED", "RIBBON", "RMNH", "RUNNING_WATER", "RURAL_POST", "SAD", "SANITIZER", "SAYANA_PRESS", "SECURITY_WORKER", "SEXUAL_REPRODUCTIVE_HEALTH", "SMALL_PLANE", "SOCIAL_DISTANCING", "SPRAYING", "SQUARE_LARGE", "SQUARE_MEDIUM", "SQUARE_SMALL", "STAR_LARGE", "STAR_MEDIUM", "STAR_SMALL", "STETHOSCOPE", "STI", "STOCK_OUT", "STOP", "SURGICAL_STERILIZATION", "SWEATING", "SYMPTOM", "SYNERGIST_INSECTICIDE_BIOASSAYS", "SYRINGE", "TAC", "TB", "TRANSGENDER", "TRAUMATISM", "TRAVEL", "TREATED_WATER", "TRIANGLE_LARGE", "TRIANGLE_MEDIUM", "TRIANGLE_SMALL", "TRUCK_DRIVER", "UN_PAVE_ROAD", "UNDERWEIGHT", "VESPA_MOTORCYCLE", "VIH_AIDS", "VIRUS", "VOMITING", "WAR", "WASH_HANDS", "WATER_SANITATION", "WATER_TREATMENT", "WEIGHT", "WOLD_CARE", "WOMAN", "YES", "YOUNG_PEOPLE" ]
}
iconData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"keywords" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
importStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "UPDATE", "CREATE_AND_UPDATE", "DELETE", "SYNC", "NEW_AND_UPDATES", "NEW", "UPDATES", "DELETES" ]
}
indicator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"annualized" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"decimals" : {
"type" : "integer"
},
"denominator" : {
"type" : "string"
},
"denominatorDescription" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDenominatorDescription" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayNumeratorDescription" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"indicatorType" : {
"$ref" : "indicatorType.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"numerator" : {
"type" : "string"
},
"numeratorDescription" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroupSet" : {
"$ref" : "indicatorGroupSet.json"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"factor" : {
"type" : "integer"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"number" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
refToTypeMapping
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
interpretation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"comments" : {
"type" : "array",
"items" : {
"$ref" : "interpretationComment.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"displayName" : {
"type" : "string"
},
"eventChart" : {
"$ref" : "eventChart.json"
},
"eventReport" : {
"$ref" : "eventReport.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"likedBy" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"likes" : {
"type" : "integer"
},
"map" : {
"$ref" : "map.json"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "mention.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "analyticsFavoriteType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "mention.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
mention
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"username" : {
"type" : "string"
}
}
}
notificationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INTERPRETATION_CREATE", "INTERPRETATION_UPDATE", "INTERPRETATION_LIKE", "COMMENT_CREATE", "COMMENT_UPDATE" ]
}
protectionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "HIDDEN", "RESTRICTED" ]
}
keyJsonValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "string"
}
}
}
leaderNodeInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"currentNodeId" : {
"type" : "string"
},
"currentNodeUuid" : {
"type" : "string"
},
"leader" : {
"type" : "boolean"
},
"leaderNodeId" : {
"type" : "string"
},
"leaderNodeUuid" : {
"type" : "string"
}
}
}
legend
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"color" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"endValue" : {
"type" : "number"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"image" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"startValue" : {
"type" : "number"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
legendDisplayStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FIXED", "BY_DATA_ITEM" ]
}
legendDisplayStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FILL", "TEXT" ]
}
legendSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legends" : {
"type" : "array",
"items" : {
"$ref" : "legend.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"symbolizer" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
eventStatus_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
externalMapLayer
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attribution" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"imageFormat" : {
"$ref" : "imageFormat.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layers" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSetUrl" : {
"type" : "string"
},
"mapLayerPosition" : {
"$ref" : "mapLayerPosition.json"
},
"mapService" : {
"$ref" : "mapService.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PNG", "JPG" ]
}
map
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"basemap" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"mapViews" : {
"type" : "array",
"items" : {
"$ref" : "mapView.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"title" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"zoom" : {
"type" : "integer"
}
}
}
mapLayerPosition
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BASEMAP", "OVERLAY" ]
}
mapService
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WMS", "TMS", "XYZ" ]
}
mapView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"areaRadius" : {
"type" : "integer"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"classes" : {
"type" : "integer"
},
"code" : {
"type" : "string"
},
"colorHigh" : {
"type" : "string"
},
"colorLow" : {
"type" : "string"
},
"colorScale" : {
"type" : "string"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"config" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventClustering" : {
"type" : "boolean"
},
"eventCoordinateField" : {
"type" : "string"
},
"eventPointColor" : {
"type" : "string"
},
"eventPointRadius" : {
"type" : "integer"
},
"eventStatus" : {
"$ref" : "eventStatus_.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"followUp" : {
"type" : "boolean"
},
"formName" : {
"type" : "string"
},
"hidden" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"labelFontColor" : {
"type" : "string"
},
"labelFontSize" : {
"type" : "string"
},
"labelFontStyle" : {
"type" : "string"
},
"labelFontWeight" : {
"type" : "string"
},
"labels" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layer" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"method" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"noDataColor" : {
"type" : "string"
},
"opacity" : {
"type" : "number"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitColor" : {
"type" : "string"
},
"organisationUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnitSelectionMode" : {
"$ref" : "organisationUnitSelectionMode.json"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraph" : {
"type" : "string"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"parentLevel" : {
"type" : "integer"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"radiusHigh" : {
"type" : "integer"
},
"radiusLow" : {
"type" : "integer"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"renderingStrategy" : {
"$ref" : "mapViewRenderingStrategy.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"styleDataItem" : { },
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"thematicMapType" : {
"$ref" : "thematicMapType.json"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
}
}
}
mapViewRenderingStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SINGLE", "SPLIT_BY_PERIOD", "TIMELINE" ]
}
thematicMapType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CHOROPLETH", "BUBBLE" ]
}
message
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "fileResource.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"internal" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"metaData" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sender" : {
"$ref" : "user.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
messageConversation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"assignee" : {
"$ref" : "user.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followUp" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastMessage" : {
"type" : "string",
"format" : "date-time"
},
"lastSender" : {
"$ref" : "user.json"
},
"lastSenderFirstname" : {
"type" : "string"
},
"lastSenderSurname" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageCount" : {
"type" : "integer"
},
"messageType" : {
"$ref" : "messageType_.json"
},
"messages" : {
"type" : "array",
"items" : {
"$ref" : "message.json"
}
},
"name" : {
"type" : "string"
},
"priority" : {
"$ref" : "messageConversationPriority.json"
},
"publicAccess" : {
"type" : "string"
},
"read" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "messageConversationStatus.json"
},
"subject" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userFirstname" : {
"type" : "string"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userMessages" : {
"type" : "array",
"items" : {
"$ref" : "userMessage.json"
}
},
"userSurname" : {
"type" : "string"
}
}
}
messageConversationPriority
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "LOW", "MEDIUM", "HIGH" ]
}
messageConversationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "OPEN", "PENDING", "INVALID", "SOLVED" ]
}
messageType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PRIVATE", "SYSTEM", "VALIDATION_RESULT", "TICKET" ]
}
userMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followUp" : {
"type" : "boolean"
},
"key" : {
"type" : "string"
},
"read" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hashCode" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"importDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "versionType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
versionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BEST_EFFORT", "ATOMIC" ]
}
minMaxDataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElement" : {
"$ref" : "dataElement.json"
},
"generated" : {
"type" : "boolean"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"optionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"source" : {
"$ref" : "organisationUnit.json"
}
}
}
minMaxValueParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSets" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnit" : {
"type" : "string"
}
}
}
nodeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SIMPLE", "COMPLEX", "COLLECTION" ]
}
preset
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "CODE", "ID_NAME", "ALL", "IDENTIFIABLE", "NAMEABLE" ]
}
include
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALWAYS", "NON_NULL", "NON_EMPTY" ]
}
include
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALWAYS", "NON_NULL", "NON_EMPTY" ]
}
expressionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VARIABLE", "TRACKED_ENTITY_ATTRIBUTE", "DATA_ELEMENT" ]
}
sendStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COLLECTIVE_SUMMARY", "SINGLE_NOTIFICATION" ]
}
externalNotificationLogEntry
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowMultiple" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastSentAt" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"notificationTemplateUid" : {
"type" : "string"
},
"notificationTriggeredBy" : {
"$ref" : "notificationTriggerEvent.json"
},
"publicAccess" : {
"type" : "string"
},
"retries" : {
"type" : "integer"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
notificationTriggerEvent
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM", "PROGRAM_STAGE", "DATA_SET", "VALIDATION_RULE" ]
}
option
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"optionGroups" : {
"type" : "array",
"items" : {
"$ref" : "optionGroup.json"
}
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
},
"version" : {
"type" : "integer"
}
}
}
featureType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "MULTI_POLYGON", "POLYGON", "POINT", "SYMBOL" ]
}
organisationUnit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"address" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"ancestors" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"children" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"closedDate" : {
"type" : "string",
"format" : "date-time"
},
"code" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"contactPerson" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"image" : {
"$ref" : "fileResource.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leaf" : {
"type" : "boolean"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"level" : {
"type" : "integer",
"readOnly" : true
},
"memberCount" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"openingDate" : {
"type" : "string",
"format" : "date-time"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"parent" : {
"$ref" : "#"
},
"path" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"phoneNumber" : {
"type" : "string"
},
"programs" : {
"type" : "array",
"items" : {
"$ref" : "program.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
organisationUnitGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"color" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"geometry" : {
"$ref" : "geometry.json"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"symbol" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
organisationUnitGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"includeSubhierarchyInAnalytics" : {
"type" : "boolean"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
organisationUnitGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"organisationUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
}
}
}
organisationUnitLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"level" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"offlineLevels" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
batchResponseStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"summaries" : {
"type" : "array",
"items" : {
"$ref" : "outboundMessageResponseSummary.json"
}
}
}
}
outboundMessageBatchStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMPLETED", "FAILED", "PENDING", "ABORTED" ]
}
outboundMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"async" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"ok" : {
"type" : "boolean"
},
"status" : {
"type" : "string"
}
}
}
outboundMessageResponseSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"batchType" : {
"$ref" : "deliveryChannel.json"
},
"errorMessage" : {
"type" : "string"
},
"failed" : {
"type" : "integer"
},
"pending" : {
"type" : "integer"
},
"responseMessage" : {
"type" : "string"
},
"sent" : {
"type" : "integer"
},
"status" : {
"$ref" : "outboundMessageBatchStatus.json"
},
"total" : {
"type" : "integer"
}
}
}
order_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MEAN_ABS_DEV", "Z_SCORE" ]
}
orgUnitSelection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DESCENDANTS", "SELECTED" ]
}
outlierDetectionAlgorithm
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "Z_SCORE", "MIN_MAX", "MOD_Z_SCORE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"algorithm" : {
"$ref" : "outlierDetectionAlgorithm.json"
},
"count" : {
"type" : "integer"
},
"dataEndDate" : {
"type" : "string",
"format" : "date-time"
},
"dataStartDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"orderBy" : {
"$ref" : "order_.json"
},
"threshold" : {
"type" : "number"
}
}
}
outlierDetectionQuery
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"algorithm" : {
"$ref" : "outlierDetectionAlgorithm.json"
},
"dataEndDate" : {
"type" : "string",
"format" : "date-time"
},
"dataStartDate" : {
"type" : "string",
"format" : "date-time"
},
"de" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"ds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"orderBy" : {
"$ref" : "order_.json"
},
"ou" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"threshold" : {
"type" : "number"
}
}
}
outlierDetectionResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "outlierDetectionMetadata.json"
},
"outlierValues" : {
"type" : "array",
"items" : {
"$ref" : "outlierValue.json"
}
}
}
}
outlierValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absDev" : {
"type" : "number"
},
"aoc" : {
"type" : "string"
},
"aocName" : {
"type" : "string"
},
"coc" : {
"type" : "string"
},
"cocName" : {
"type" : "string"
},
"de" : {
"type" : "string"
},
"deName" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lowerBound" : {
"type" : "number"
},
"mean" : {
"type" : "number"
},
"median" : {
"type" : "number"
},
"ou" : {
"type" : "string"
},
"ouName" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"stdDev" : {
"type" : "number"
},
"upperBound" : {
"type" : "number"
},
"value" : {
"type" : "number"
},
"zScore" : {
"type" : "number"
}
}
}
mutation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"operation" : {
"$ref" : "operation.json"
},
"path" : {
"type" : "string"
},
"value" : { }
}
}
operation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ADDITION", "DELETION" ]
}
patch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"mutations" : {
"type" : "array",
"items" : {
"$ref" : "mutation.json"
}
}
}
}
configurablePeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
period
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
periodType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
relativePeriodEnum
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TODAY", "YESTERDAY", "LAST_3_DAYS", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "LAST_60_DAYS", "LAST_90_DAYS", "LAST_180_DAYS", "THIS_MONTH", "LAST_MONTH", "THIS_BIMONTH", "LAST_BIMONTH", "THIS_QUARTER", "LAST_QUARTER", "THIS_SIX_MONTH", "LAST_SIX_MONTH", "WEEKS_THIS_YEAR", "MONTHS_THIS_YEAR", "BIMONTHS_THIS_YEAR", "QUARTERS_THIS_YEAR", "THIS_YEAR", "MONTHS_LAST_YEAR", "QUARTERS_LAST_YEAR", "LAST_YEAR", "LAST_5_YEARS", "LAST_10_YEARS", "LAST_12_MONTHS", "LAST_6_MONTHS", "LAST_3_MONTHS", "LAST_6_BIMONTHS", "LAST_4_QUARTERS", "LAST_2_SIXMONTHS", "THIS_FINANCIAL_YEAR", "LAST_FINANCIAL_YEAR", "LAST_5_FINANCIAL_YEARS", "LAST_10_FINANCIAL_YEARS", "THIS_WEEK", "LAST_WEEK", "THIS_BIWEEK", "LAST_BIWEEK", "LAST_4_WEEKS", "LAST_4_BIWEEKS", "LAST_12_WEEKS", "LAST_52_WEEKS" ]
}
relativePeriods
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"biMonthsThisYear" : {
"type" : "boolean"
},
"last10FinancialYears" : {
"type" : "boolean"
},
"last10Years" : {
"type" : "boolean"
},
"last12Months" : {
"type" : "boolean"
},
"last12Weeks" : {
"type" : "boolean"
},
"last14Days" : {
"type" : "boolean"
},
"last180Days" : {
"type" : "boolean"
},
"last2SixMonths" : {
"type" : "boolean"
},
"last30Days" : {
"type" : "boolean"
},
"last3Days" : {
"type" : "boolean"
},
"last3Months" : {
"type" : "boolean"
},
"last4BiWeeks" : {
"type" : "boolean"
},
"last4Quarters" : {
"type" : "boolean"
},
"last4Weeks" : {
"type" : "boolean"
},
"last52Weeks" : {
"type" : "boolean"
},
"last5FinancialYears" : {
"type" : "boolean"
},
"last5Years" : {
"type" : "boolean"
},
"last60Days" : {
"type" : "boolean"
},
"last6BiMonths" : {
"type" : "boolean"
},
"last6Months" : {
"type" : "boolean"
},
"last7Days" : {
"type" : "boolean"
},
"last90Days" : {
"type" : "boolean"
},
"lastBiWeek" : {
"type" : "boolean"
},
"lastBimonth" : {
"type" : "boolean"
},
"lastFinancialYear" : {
"type" : "boolean"
},
"lastMonth" : {
"type" : "boolean"
},
"lastQuarter" : {
"type" : "boolean"
},
"lastSixMonth" : {
"type" : "boolean"
},
"lastWeek" : {
"type" : "boolean"
},
"lastYear" : {
"type" : "boolean"
},
"monthsLastYear" : {
"type" : "boolean"
},
"monthsThisYear" : {
"type" : "boolean"
},
"quartersLastYear" : {
"type" : "boolean"
},
"quartersThisYear" : {
"type" : "boolean"
},
"thisBiWeek" : {
"type" : "boolean"
},
"thisBimonth" : {
"type" : "boolean"
},
"thisDay" : {
"type" : "boolean"
},
"thisFinancialYear" : {
"type" : "boolean"
},
"thisMonth" : {
"type" : "boolean"
},
"thisQuarter" : {
"type" : "boolean"
},
"thisSixMonth" : {
"type" : "boolean"
},
"thisWeek" : {
"type" : "boolean"
},
"thisYear" : {
"type" : "boolean"
},
"weeksThisYear" : {
"type" : "boolean"
},
"yesterday" : {
"type" : "boolean"
}
}
}
predictor
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"annualSampleCount" : {
"type" : "integer"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"generator" : {
"$ref" : "expression.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitLevel.json"
}
},
"output" : {
"$ref" : "dataElement.json"
},
"outputCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"periodType" : {
"$ref" : "periodType.json"
},
"predictorGroups" : {
"type" : "array",
"items" : {
"$ref" : "predictorGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sampleSkipTest" : {
"$ref" : "expression.json"
},
"sequentialSampleCount" : {
"type" : "integer"
},
"sequentialSkipCount" : {
"type" : "integer"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
predictorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"predictors" : {
"type" : "array",
"items" : {
"$ref" : "predictor.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
preheatErrorReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"errorKlass" : {
"type" : "string"
},
"errorProperties" : {
"type" : "array",
"items" : { }
},
"errorProperty" : {
"type" : "string"
},
"mainId" : {
"type" : "string"
},
"mainKlass" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"value" : { }
}
}
preheatIdentifier
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UID", "CODE" ]
}
preheatMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "REFERENCE", "ALL", "NONE" ]
}
analyticsPeriodBoundary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"analyticsPeriodBoundaryType" : {
"$ref" : "analyticsPeriodBoundaryType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"boundaryTarget" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"offsetPeriodType" : {
"$ref" : "periodType.json"
},
"offsetPeriods" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
analyticsPeriodBoundaryType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BEFORE_START_OF_REPORTING_PERIOD", "BEFORE_END_OF_REPORTING_PERIOD", "AFTER_START_OF_REPORTING_PERIOD", "AFTER_END_OF_REPORTING_PERIOD" ]
}
analyticsType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT" ]
}
program
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accessLevel" : {
"$ref" : "accessLevel.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"completeEventsExpiryDays" : {
"type" : "integer"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayEnrollmentDateLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayFrontPageList" : {
"type" : "boolean"
},
"displayIncidentDate" : {
"type" : "boolean"
},
"displayIncidentDateLabel" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"enrollmentDateLabel" : {
"type" : "string"
},
"expiryDays" : {
"type" : "integer"
},
"expiryPeriodType" : {
"$ref" : "periodType.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"ignoreOverdueEvents" : {
"type" : "boolean"
},
"incidentDateLabel" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"maxTeiCountToReturn" : {
"type" : "integer"
},
"minAttributesRequiredToSearch" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"onlyEnrollOnce" : {
"type" : "boolean"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programRuleVariables" : {
"type" : "array",
"items" : {
"$ref" : "programRuleVariable.json"
}
},
"programSections" : {
"type" : "array",
"items" : {
"$ref" : "programSection.json"
}
},
"programStages" : {
"type" : "array",
"items" : {
"$ref" : "programStage.json"
}
},
"programTrackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttribute.json"
}
},
"programType" : {
"$ref" : "programType.json"
},
"publicAccess" : {
"type" : "string"
},
"registration" : {
"type" : "boolean"
},
"relatedProgram" : {
"$ref" : "#"
},
"selectEnrollmentDatesInFuture" : {
"type" : "boolean"
},
"selectIncidentDatesInFuture" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipOffline" : {
"type" : "boolean"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"useFirstStageDuringRegistration" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"version" : {
"type" : "integer"
},
"withoutRegistration" : {
"type" : "boolean"
}
}
}
programDataElementDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programExpression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"expression" : {
"type" : "string"
}
}
}
programIndicator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"analyticsPeriodBoundaries" : {
"type" : "array",
"items" : {
"$ref" : "analyticsPeriodBoundary.json"
}
},
"analyticsType" : {
"$ref" : "analyticsType_.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"decimals" : {
"type" : "integer"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInForm" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "programIndicatorGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programIndicatorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"completedBy" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"enrollmentDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"incidentDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"messageConversations" : {
"type" : "array",
"items" : {
"$ref" : "messageConversation.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"programStageInstances" : {
"type" : "array",
"items" : {
"$ref" : "programStageInstance.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "programStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityComments" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityComment.json"
}
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programOwnershipHistory
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"createdBy" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"entityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
}
}
}
programSection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttribute.json"
}
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowGenerateNextVisit" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"autoGenerateEvent" : {
"type" : "boolean"
},
"blockEntryForm" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDueDateLabel" : {
"type" : "string"
},
"displayExecutionDateLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayGenerateEventBox" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"dueDateLabel" : {
"type" : "string"
},
"enableUserAssignment" : {
"type" : "boolean"
},
"executionDateLabel" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"formType" : {
"$ref" : "formType.json"
},
"generatedByEnrollmentDate" : {
"type" : "boolean"
},
"hideDueDate" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"minDaysFromStart" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"nextScheduleDate" : {
"$ref" : "dataElement.json"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"openAfterEnrollment" : {
"type" : "boolean"
},
"periodType" : {
"$ref" : "periodType.json"
},
"preGenerateUID" : {
"type" : "boolean"
},
"program" : {
"$ref" : "program.json"
},
"programStageDataElements" : {
"type" : "array",
"items" : {
"$ref" : "programStageDataElement.json"
}
},
"programStageSections" : {
"type" : "array",
"items" : {
"$ref" : "programStageSection.json"
}
},
"publicAccess" : {
"type" : "string"
},
"remindCompleted" : {
"type" : "boolean"
},
"repeatable" : {
"type" : "boolean"
},
"reportDateToUse" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"standardInterval" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationStrategy" : {
"$ref" : "validationStrategy.json"
}
}
}
programStageDataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowFutureDate" : {
"type" : "boolean"
},
"allowProvidedElsewhere" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayInReports" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"renderOptionsAsRadio" : {
"type" : "boolean"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skipAnalytics" : {
"type" : "boolean"
},
"skipSynchronization" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"assignedUser" : {
"$ref" : "user.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"comments" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityComment.json"
}
},
"completed" : {
"type" : "boolean"
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string",
"format" : "date-time"
},
"creatableInSearchScope" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"dueDate" : {
"type" : "string",
"format" : "date-time"
},
"eventDataValues" : {
"type" : "array",
"items" : {
"$ref" : "eventDataValue.json"
}
},
"eventDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"messageConversations" : {
"type" : "array",
"items" : {
"$ref" : "messageConversation.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "eventStatus.json"
},
"storedBy" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageSection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
programTempOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"reason" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"validTill" : {
"type" : "string",
"format" : "date-time"
}
}
}
programTempOwnershipAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"accessedBy" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"reason" : {
"type" : "string"
}
}
}
programTrackedEntityAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowFutureDate" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayInList" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"programTrackedEntityAttributeGroups" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttributeGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"renderOptionsAsRadio" : {
"type" : "boolean"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"searchable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sortOrder" : {
"type" : "integer"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programTrackedEntityAttributeDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programTrackedEntityAttributeGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttribute.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"uniqunessType" : {
"$ref" : "uniqunessType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WITH_REGISTRATION", "WITHOUT_REGISTRATION" ]
}
uniqunessType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "STRICT", "VALIDATION" ]
}
userInfoSnapshot
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"firstName" : {
"type" : "string"
},
"surname" : {
"type" : "string"
},
"uid" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
}
}
validationStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ON_COMPLETE", "ON_UPDATE_AND_INSERT" ]
}
programMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageStatus" : {
"$ref" : "programMessageStatus.json"
},
"name" : {
"type" : "string"
},
"notificationTemplate" : {
"type" : "string"
},
"processedDate" : {
"type" : "string",
"format" : "date-time"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"publicAccess" : {
"type" : "string"
},
"recipients" : {
"$ref" : "programMessageRecipients.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"storeCopy" : {
"type" : "boolean"
},
"subject" : {
"type" : "string"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programMessageBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deliveryChannels(Set<DeliveryChannel>)" : {
"$ref" : "#"
},
"messageStatus(ProgramMessageStatus)" : {
"$ref" : "#"
},
"notificationTemplate(String)" : {
"$ref" : "#"
},
"processedDate(Date)" : {
"$ref" : "#"
},
"programInstance(ProgramInstance)" : {
"$ref" : "#"
},
"programStageInstance(ProgramStageInstance)" : {
"$ref" : "#"
},
"recipients(ProgramMessageRecipients)" : {
"$ref" : "#"
},
"storeCopy(boolean)" : {
"$ref" : "#"
},
"subject(String)" : {
"$ref" : "#"
},
"text(String)" : {
"$ref" : "#"
}
}
}
programMessageBatch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"programMessages" : {
"type" : "array",
"items" : {
"$ref" : "programMessage.json"
}
}
}
}
programMessageCategory
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCOMING", "OUTGOING" ]
}
programMessageRecipients
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"emailAddresses" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"phoneNumbers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
programMessageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SENT", "FAILED", "SCHEDULED", "OUTBOUND" ]
}
notificationTrigger
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ENROLLMENT", "COMPLETION", "PROGRAM_RULE", "SCHEDULED_DAYS_DUE_DATE", "SCHEDULED_DAYS_INCIDENT_DATE", "SCHEDULED_DAYS_ENROLLMENT_DATE" ]
}
programNotificationInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programNotificationTemplateId" : {
"type" : "integer"
},
"programNotificationTemplateSnapshot" : {
"$ref" : "programNotificationTemplateSnapshot.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"publicAccess" : {
"type" : "string"
},
"scheduledAt" : {
"type" : "string",
"format" : "date-time"
},
"sentAt" : {
"type" : "string",
"format" : "date-time"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "ORGANISATION_UNIT_CONTACT", "USERS_AT_ORGANISATION_UNIT", "USER_GROUP", "PROGRAM_ATTRIBUTE", "DATA_ELEMENT", "WEB_HOOK" ]
}
programNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "ORGANISATION_UNIT_CONTACT", "USERS_AT_ORGANISATION_UNIT", "USER_GROUP", "PROGRAM_ATTRIBUTE", "DATA_ELEMENT", "WEB_HOOK" ]
}
programNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "programNotificationRecipient.json"
},
"notificationTrigger" : {
"$ref" : "notificationTrigger.json"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientDataElement" : {
"$ref" : "dataElement.json"
},
"recipientProgramAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"recipientUserGroup" : {
"$ref" : "userGroup.json"
},
"relativeScheduledDays" : {
"type" : "integer"
},
"sendRepeatable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "PROGRAM_STAGE_NAME", "ORG_UNIT_NAME", "DUE_DATE", "DAYS_SINCE_DUE_DATE", "DAYS_UNTIL_DUE_DATE", "CURRENT_DATE", "EVENT_DATE", "PROGRAM_ID", "EVENT_ORG_UNIT_ID", "ENROLLMENT_ORG_UNIT_ID", "PROGRAM_STAGE_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programStageTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "PROGRAM_STAGE_NAME", "ORG_UNIT_NAME", "DUE_DATE", "DAYS_SINCE_DUE_DATE", "DAYS_UNTIL_DUE_DATE", "CURRENT_DATE", "EVENT_DATE", "PROGRAM_ID", "EVENT_ORG_UNIT_ID", "ENROLLMENT_ORG_UNIT_ID", "PROGRAM_STAGE_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "ORG_UNIT_NAME", "CURRENT_DATE", "ENROLLMENT_DATE", "DAYS_SINCE_ENROLLMENT_DATE", "INCIDENT_DATE", "PROGRAM_ID", "ENROLLMENT_ORG_UNIT_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "ORG_UNIT_NAME", "CURRENT_DATE", "ENROLLMENT_DATE", "DAYS_SINCE_ENROLLMENT_DATE", "INCIDENT_DATE", "PROGRAM_ID", "ENROLLMENT_ORG_UNIT_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programNotificationTemplateSnapshot
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"messageTemplate" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "programNotificationRecipient.json"
},
"notificationTrigger" : {
"$ref" : "notificationTrigger.json"
},
"sendRepeatable" : {
"type" : "boolean"
},
"subjectTemplate" : {
"type" : "string"
}
}
}
programRule
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"condition" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"priority" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"programRuleActions" : {
"type" : "array",
"items" : {
"$ref" : "programRuleAction.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleAction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"content" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"data" : {
"type" : "string"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayContent" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"location" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"option" : {
"$ref" : "option.json"
},
"optionGroup" : {
"$ref" : "optionGroup.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
},
"programRule" : {
"$ref" : "programRule.json"
},
"programRuleActionEvaluationEnvironments" : {
"type" : "array",
"items" : {
"$ref" : "programRuleActionEvaluationEnvironment.json"
}
},
"programRuleActionEvaluationTime" : {
"$ref" : "programRuleActionEvaluationTime.json"
},
"programRuleActionType" : {
"$ref" : "programRuleActionType.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStageSection" : {
"$ref" : "programStageSection.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"templateUid" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleActionEvaluationEnvironment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WEB", "ANDROID" ]
}
programRuleActionEvaluationTime
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ON_DATA_ENTRY", "ON_COMPLETE", "ALWAYS" ]
}
programRuleActionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DISPLAYTEXT", "DISPLAYKEYVALUEPAIR", "HIDEFIELD", "HIDESECTION", "HIDEPROGRAMSTAGE", "ASSIGN", "SHOWWARNING", "WARNINGONCOMPLETE", "SHOWERROR", "ERRORONCOMPLETE", "CREATEEVENT", "SETMANDATORYFIELD", "SENDMESSAGE", "SCHEDULEMESSAGE", "HIDEOPTION", "SHOWOPTIONGROUP", "HIDEOPTIONGROUP" ]
}
programRuleVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"programRuleVariableSourceType" : {
"$ref" : "programRuleVariableSourceType.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"useCodeForOptionSet" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleVariableSourceType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATAELEMENT_NEWEST_EVENT_PROGRAM_STAGE", "DATAELEMENT_NEWEST_EVENT_PROGRAM", "DATAELEMENT_CURRENT_EVENT", "DATAELEMENT_PREVIOUS_EVENT", "CALCULATED_VALUE", "TEI_ATTRIBUTE" ]
}
dateFilterPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"endBuffer" : {
"type" : "integer"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"period" : {
"$ref" : "relativePeriodEnum.json"
},
"startBuffer" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"type" : {
"$ref" : "datePeriodType.json"
}
}
}
datePeriodType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RELATIVE", "ABSOLUTE" ]
}
eventDataFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataItem" : {
"type" : "string"
},
"dateFilter" : {
"$ref" : "dateFilterPeriod.json"
},
"eq" : {
"type" : "string"
},
"ge" : {
"type" : "string"
},
"gt" : {
"type" : "string"
},
"in" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"le" : {
"type" : "string"
},
"like" : {
"type" : "string"
},
"lt" : {
"type" : "string"
}
}
}
eventQueryCriteria
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUserMode" : {
"$ref" : "assignedUserSelectionMode.json"
},
"assignedUsers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"completedDate" : {
"$ref" : "dateFilterPeriod.json"
},
"dataFilters" : {
"type" : "array",
"items" : {
"$ref" : "eventDataFilter.json"
}
},
"displayColumnOrder" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dueDate" : {
"$ref" : "dateFilterPeriod.json"
},
"eventDate" : {
"$ref" : "dateFilterPeriod.json"
},
"events" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followUp" : {
"type" : "boolean"
},
"lastUpdatedDate" : {
"$ref" : "dateFilterPeriod.json"
},
"order" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"ouMode" : {
"$ref" : "organisationUnitSelectionMode.json"
},
"status" : {
"$ref" : "eventStatus.json"
}
}
}
programStageInstanceFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"eventQueryCriteria" : {
"$ref" : "eventQueryCriteria.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
pushAnalysis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboard" : {
"$ref" : "dashboard.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"message" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"title" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
schedulingFrequency
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "MONTHLY" ]
}
direction_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASCENDING", "DESCENDING" ]
}
stringSearchMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EQUALS", "NOT_EQUALS", "ANYWHERE", "NOT_ANYWHERE", "STARTING_LIKE", "NOT_STARTING_LIKE", "LIKE", "NOT_LIKE", "ENDING_LIKE", "NOT_ENDING_LIKE" ]
}
type
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AND", "OR" ]
}
matchMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EXACT", "START", "END", "ANYWHERE" ]
}
relationship_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"from" : {
"$ref" : "relationshipItem_.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"relationshipType" : {
"$ref" : "relationshipType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"to" : {
"$ref" : "relationshipItem_.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
relationshipConstraint
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"program" : {
"$ref" : "program.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"relationshipEntity" : {
"$ref" : "relationshipEntity.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
}
}
}
relationshipEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "PROGRAM_INSTANCE", "PROGRAM_STAGE_INSTANCE" ]
}
relationshipItem_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"relationship" : {
"$ref" : "relationship_.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
relationshipType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"bidirectional" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayFromToName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayToFromName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fromConstraint" : {
"$ref" : "relationshipConstraint.json"
},
"fromToName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"toConstraint" : {
"$ref" : "relationshipConstraint.json"
},
"toFromName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
deviceRenderTypeMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
objectValueTypeRenderingOption
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"clazz" : {
"type" : "string"
},
"hasOptionSet" : {
"type" : "boolean"
},
"renderingTypes" : {
"type" : "array",
"items" : {
"$ref" : "valueTypeRenderingType.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
renderDevice
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DESKTOP", "MOBILE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "JSON", "XML", "CSV" ]
}
sectionRenderingObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"$ref" : "sectionRenderingType.json"
}
}
}
sectionRenderingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LISTING", "SEQUENTIAL", "MATRIX" ]
}
valueTypeRenderingObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"decimalPoints" : {
"type" : "integer"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"step" : {
"type" : "integer"
},
"type" : {
"$ref" : "valueTypeRenderingType.json"
}
}
}
valueTypeRenderingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DEFAULT", "DROPDOWN", "VERTICAL_RADIOBUTTONS", "HORIZONTAL_RADIOBUTTONS", "VERTICAL_CHECKBOXES", "HORIZONTAL_CHECKBOXES", "SHARED_HEADER_RADIOBUTTONS", "ICONS_AS_BUTTONS", "SPINNER", "ICON", "TOGGLE", "VALUE", "SLIDER", "LINEAR_SCALE", "AUTOCOMPLETE", "QR_CODE", "BAR_CODE" ]
}
report
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cacheStrategy" : {
"$ref" : "cacheStrategy.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"designContent" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"reportParams" : {
"$ref" : "reportingParams.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "reportType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
}
}
}
reportType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "JASPER_REPORT_TABLE", "JASPER_JDBC", "HTML" ]
}
reservedValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"expiryDate" : {
"type" : "string",
"format" : "date-time"
},
"key" : {
"type" : "string"
},
"ownerObject" : {
"type" : "string"
},
"ownerUid" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
resourceTableType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORG_UNIT_STRUCTURE", "DATA_SET_ORG_UNIT_CATEGORY", "CATEGORY_OPTION_COMBO_NAME", "DATA_ELEMENT_GROUP_SET_STRUCTURE", "INDICATOR_GROUP_SET_STRUCTURE", "ORG_UNIT_GROUP_SET_STRUCTURE", "CATEGORY_STRUCTURE", "DATA_ELEMENT_STRUCTURE", "PERIOD_STRUCTURE", "DATE_PERIOD_STRUCTURE", "DATA_ELEMENT_CATEGORY_OPTION_COMBO", "DATA_APPROVAL_REMAP_LEVEL", "DATA_APPROVAL_MIN_LEVEL" ]
}
itemValueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NUMBER", "DATE", "TEXT", "BOOLEAN" ]
}
ruleEngineIntent
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVALUATION", "DESCRIPTION" ]
}
gS1Elements
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "GS1_E0_IDENTIFIER", "GS1_E1_IDENTIFIER", "GS1_E2_IDENTIFIER", "GS1_E3_IDENTIFIER", "GS1_E4_IDENTIFIER", "GS1_I1_IDENTIFIER", "GS1_C1_IDENTIFIER", "GS1_e0_IDENTIFIER", "GS1_e1_IDENTIFIER", "GS1_e2_IDENTIFIER", "GS1_d2_IDENTIFIER", "GS1_Q3_IDENTIFIER", "GS1_J1_IDENTIFIER", "GS1_d1_IDENTIFIER", "GS1_Q1_IDENTIFIER", "GS1_GROUP_SEPARATOR", "SSCC", "GTIN", "CONTENT", "LOT_NUMBER", "PROD_DATE", "DUE_DATE", "PACK_DATE", "BEST_BEFORE_DATE", "SELL_BY", "EXP_DATE", "VARIANT", "SERIAL_NUMBER", "CPV", "TPX", "ADDITIONAL_ID", "CUSTOMER_PART_NUMBER", "MTO_VARIANT_NUMBER", "PCN", "SECONDARY_SERIAL", "REF_TO_SOURCE", "GDTI", "GLN_EXTENSION_COMPONENT", "GCN", "VAR_COUNT", "NET_WEIGHT_KG", "LENGTH_M", "WIDTH_M", "HEIGHT_M", "AREA_M2", "NET_VOLUME_L", "NET_VOLUME_M3", "NET_WEIGHT_LB", "LENGTH_I", "LENGTH_F", "LENGTH_Y", "WIDTH_I", "WIDTH_F", "WIDTH_Y", "HEIGHT_I", "HEIGHT_F", "HEIGHT_Y", "GROSS_WEIGHT_GF", "LENGTH_M_LOG", "WIDTH_M_LOG", "HEIGHT_M_LOG", "AREA_M2_LOG", "VOLUME_L_LOG", "VOLUME_M3_LOG", "KG_PER_M2", "GROSS_WHEIGHT_LB", "LENGTH_I_LOG", "LENGTH_F_LOG", "LENGTH_Y_LOG", "WIDTH_I_LOG", "WIDTH_F_LOG", "WIDTH_Y_LOG", "HEIGHT_I_LOG", "HEIGHT_F_LOG", "HEIGHT_Y_LOG", "AREA_I2", "AREA_F2", "AREA_Y2", "AREA_I2_LOG", "AREA_F2_LOG", "AREA_Y2_LOG", "NET_WEIGHT_T", "NET_VOLUME_OZ", "NET_VOLUME_Q", "NET_VOLUME_G", "VOLUME_Q_LOG", "VOLUME_G_LOG", "VOLUME_I3", "VOLUME_F3", "VOLUME_Y3", "VOLUME_I3_LOG", "VOLUME_F3_LOG", "VOLUME_Y3_LOG", "COUNT", "AMOUNT", "AMOUNT_ISO", "PRICE", "PRICE_ISO", "PRCNT_OFF", "PRICE_UOM", "ORDER_NUMBER", "GINC", "ROUTE", "SHIP_TO_GLOB_LOC", "BILL_TO_LOC", "PURCHASED_FROM", "SHIP_FOR_LOG", "LOC_NUMBER", "PAY_TO", "PROD_SERV_LOC", "PARTY", "SHIP_TO_POST", "SHIP_TO_POST_ISO", "ORIGIN", "COUNTRY_INITIAL_PROCESS", "COUNTRY_PROCESS", "COUNTRY_DISASSEMBLY", "COUNTRY_FULL_PROCESS", "ORIGIN_SUBDIVISION", "SHIP_TO_COMP", "SHIP_TO_NAME", "SHIP_TO_ADD1", "SHIP_TO_ADD2", "SHIP_TO_SUB", "SHIP_TO_LOCALITY", "SHIP_TO_REG", "SHIP_TO_COUNTRY", "SHIP_TO_PHONE", "RTN_TO_COMP", "RTN_TO_NAME", "RTN_TO_ADD1", "RTN_TO_ADD2", "RTN_TO_SUB", "RTN_TO_LOCALITY", "RTN_TO_REG", "RTN_TO_COUNTRY", "RTN_TO_POST", "RTN_TO_PHONE", "SRV_DESCRIPTION", "DANGEROUS_GOODS", "AUTH_LEAV", "SIG_REQUIRED", "NBEF_DEL_DT", "NAFT_DEL_DT", "REL_DATE", "NSN", "MEAT_CUT", "EXP_TIME", "ACTIVE_POTENCY", "CATCH_AREA", "FIRST_FREEZE_DATE", "HARVEST_DATE", "AQUATIC_SPECIES", "FISHING_GEAR_TYPE", "PROD_METHID", "REFURB_LOT", "FUNC_STAT", "REV_STAT", "GIAI_ASSEMBLY", "PROCESSOR_NUMBER", "UIC_EXT", "NHRN_PZN", "NHRN_CIP", "NHRN_CN", "NHRN_DRN", "NHRN_AIM", "CERT_NUMBER", "PROTOCOL", "DIMENSIONS", "CMT_NUMBER", "GRAI", "GIAI", "PRICE_PER_UNIT", "ITIP", "IBAN", "PROD_TIME", "OPTSEN", "CPID", "CPID_SERIAL", "VERSION", "GMN", "GSRN_PROVIDER", "GSRN_RECIPIENT", "SRIN", "REF_NUMBER", "ITIP_CONTENT", "COUPON_USA", "POINTS", "POSITIVE_OFFER_COUPON_USA", "PRODUCT_URL", "AGREEMENT_INTERNAL", "COMPANY_INTERNAL_1", "COMPANY_INTERNAL_2", "COMPANY_INTERNAL_3", "COMPANY_INTERNAL_4", "COMPANY_INTERNAL_5", "COMPANY_INTERNAL_6", "COMPANY_INTERNAL_7", "COMPANY_INTERNAL_8", "COMPANY_INTERNAL_9" ]
}
attributeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT", "TRACKED_ENTITY_ATTRIBUTE", "UNKNOWN" ]
}
status_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
status__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "SCHEDULE", "SKIPPED", "VISITED", "OVERDUE" ]
}
ruleValueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "NUMERIC", "BOOLEAN", "DATE" ]
}
supplementaryDataKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "USER", "ANDROID_VERSION" ]
}
trackerObjectType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT" ]
}
triggerEnvironment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ANDROIDCLIENT", "SERVER" ]
}
jobConfiguration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"configurable" : {
"type" : "boolean",
"readOnly" : true
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cronExpression" : {
"type" : "string"
},
"delay" : {
"type" : "integer"
},
"displayName" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"jobParameters" : {
"anyOf" : [ {
"$ref" : "analyticsJobParameters.json"
}, {
"$ref" : "continuousAnalyticsJobParameters.json"
}, {
"$ref" : "monitoringJobParameters.json"
}, {
"$ref" : "predictorJobParameters.json"
}, {
"$ref" : "pushAnalysisJobParameters.json"
}, {
"$ref" : "smsJobParameters.json"
}, {
"$ref" : "metadataSyncJobParameters.json"
}, {
"$ref" : "eventProgramsDataSynchronizationJobParameters.json"
}, {
"$ref" : "trackerProgramsDataSynchronizationJobParameters.json"
}, {
"$ref" : "dataSynchronizationJobParameters.json"
}, {
"$ref" : "disableInactiveUsersJobParameters.json"
} ]
},
"jobStatus" : {
"$ref" : "jobStatus.json"
},
"jobType" : {
"$ref" : "jobType.json"
},
"lastExecuted" : {
"type" : "string",
"readOnly" : true,
"format" : "date-time"
},
"lastExecutedStatus" : {
"$ref" : "jobStatus.json"
},
"lastRuntimeExecution" : {
"type" : "string",
"readOnly" : true
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leaderOnlyJob" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"nextExecutionTime" : {
"type" : "string",
"readOnly" : true,
"format" : "date-time"
},
"publicAccess" : {
"type" : "string"
},
"schedulingType" : {
"$ref" : "schedulingType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userUid" : {
"type" : "string",
"readOnly" : true
}
}
}
jobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
jobStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RUNNING", "COMPLETED", "STOPPED", "SCHEDULED", "DISABLED", "FAILED", "NOT_STARTED" ]
}
jobType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_STATISTICS", "DATA_INTEGRITY", "RESOURCE_TABLE", "ANALYTICS_TABLE", "CONTINUOUS_ANALYTICS_TABLE", "DATA_SYNC", "TRACKER_PROGRAMS_DATA_SYNC", "EVENT_PROGRAMS_DATA_SYNC", "FILE_RESOURCE_CLEANUP", "IMAGE_PROCESSING", "META_DATA_SYNC", "SMS_SEND", "SEND_SCHEDULED_MESSAGE", "PROGRAM_NOTIFICATIONS", "VALIDATION_RESULTS_NOTIFICATION", "CREDENTIALS_EXPIRY_ALERT", "MONITORING", "PUSH_ANALYSIS", "PREDICTOR", "DATA_SET_NOTIFICATION", "REMOVE_USED_OR_EXPIRED_RESERVED_VALUES", "TRACKER_IMPORT_JOB", "TRACKER_IMPORT_NOTIFICATION_JOB", "TRACKER_IMPORT_RULE_ENGINE_JOB", "LEADER_ELECTION", "LEADER_RENEWAL", "COMPLETE_DATA_SET_REGISTRATION_IMPORT", "DATAVALUE_IMPORT_INTERNAL", "METADATA_IMPORT", "DATAVALUE_IMPORT", "EVENT_IMPORT", "ENROLLMENT_IMPORT", "TEI_IMPORT", "DISABLE_INACTIVE_USERS", "ACCOUNT_EXPIRY_ALERT", "MOCK", "GML_IMPORT", "ANALYTICSTABLE_UPDATE", "PROGRAM_DATA_SYNC" ]
}
jobTypeInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"jobParameters" : {
"type" : "array",
"items" : {
"$ref" : "property.json"
}
},
"jobType" : {
"$ref" : "jobType.json"
},
"name" : {
"type" : "string"
},
"schedulingType" : {
"$ref" : "schedulingType.json"
}
}
}
schedulingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CRON", "FIXED_DELAY" ]
}
analyticsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastYears" : {
"type" : "integer"
},
"skipPrograms" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipResourceTables" : {
"type" : "boolean"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
continuousAnalyticsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fullUpdateHourOfDay" : {
"type" : "integer"
},
"lastYears" : {
"type" : "integer"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
dataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
disableInactiveUsersJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"inactiveMonths" : {
"type" : "integer"
},
"reminderDaysBefore" : {
"type" : "integer"
}
},
"required" : [ "inactiveMonths" ]
}
eventProgramsDataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataValuesPageSize" : {
"type" : "integer"
},
"eventProgramPageSize" : {
"type" : "integer"
},
"trackerProgramPageSize" : {
"type" : "integer"
}
}
}
mockJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
}
}
}
monitoringJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistResults" : {
"type" : "boolean"
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
},
"sendNotifications" : {
"type" : "boolean"
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
predictorJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"predictorGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"predictors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
}
}
}
pushAnalysisJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pushAnalysis" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "pushAnalysis" ]
}
smsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"recipientsList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"smsSubject" : {
"type" : "string"
}
}
}
trackerProgramsDataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastYears" : {
"type" : "integer"
},
"skipPrograms" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipResourceTables" : {
"type" : "boolean"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
customJobParameters_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fullUpdateHourOfDay" : {
"type" : "integer"
},
"lastYears" : {
"type" : "integer"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
customJobParameters__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters___
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"inactiveMonths" : {
"type" : "integer"
},
"reminderDaysBefore" : {
"type" : "integer"
}
},
"required" : [ "inactiveMonths" ]
}
customJobParameters____
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters_____
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataValuesPageSize" : {
"type" : "integer"
},
"eventProgramPageSize" : {
"type" : "integer"
},
"trackerProgramPageSize" : {
"type" : "integer"
}
}
}
customJobParameters______
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistResults" : {
"type" : "boolean"
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
},
"sendNotifications" : {
"type" : "boolean"
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
customJobParameters_______
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"predictorGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"predictors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
}
}
}
customJobParameters________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pushAnalysis" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "pushAnalysis" ]
}
customJobParameters_________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"recipientsList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"smsSubject" : {
"type" : "string"
}
}
}
customJobParameters__________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
gistPreferences
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"included" : {
"$ref" : "include_.json"
},
"transformation" : {
"$ref" : "transform.json"
}
}
}
property
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"analyticalObject" : {
"type" : "boolean"
},
"apiEndpoint" : {
"type" : "string"
},
"attribute" : {
"type" : "boolean"
},
"cascade" : {
"type" : "string"
},
"collection" : {
"type" : "boolean"
},
"collectionName" : {
"type" : "string"
},
"collectionWrapping" : {
"type" : "boolean"
},
"constants" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"defaultValue" : { },
"description" : {
"type" : "string"
},
"embeddedObject" : {
"type" : "boolean"
},
"fieldName" : {
"type" : "string"
},
"gistPreferences" : {
"$ref" : "gistPreferences.json"
},
"href" : {
"type" : "string"
},
"i18nTranslationKey" : {
"type" : "string"
},
"identifiableObject" : {
"type" : "boolean"
},
"inverseRole" : {
"type" : "string"
},
"itemKlass" : {
"type" : "string"
},
"itemPropertyType" : {
"$ref" : "propertyType.json"
},
"klass" : {
"type" : "string"
},
"length" : {
"type" : "integer"
},
"manyToMany" : {
"type" : "boolean"
},
"manyToOne" : {
"type" : "boolean"
},
"max" : {
"type" : "number"
},
"min" : {
"type" : "number"
},
"name" : {
"type" : "string"
},
"nameableObject" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"oneToMany" : {
"type" : "boolean"
},
"oneToOne" : {
"type" : "boolean"
},
"ordered" : {
"type" : "boolean"
},
"owner" : {
"type" : "boolean"
},
"owningRole" : {
"type" : "string"
},
"persisted" : {
"type" : "boolean"
},
"propertyTransformer" : {
"type" : "boolean"
},
"propertyType" : {
"$ref" : "propertyType.json"
},
"readable" : {
"type" : "boolean"
},
"relativeApiEndpoint" : {
"type" : "string"
},
"required" : {
"type" : "boolean"
},
"simple" : {
"type" : "boolean"
},
"translatable" : {
"type" : "boolean"
},
"translationKey" : {
"type" : "string"
},
"unique" : {
"type" : "boolean"
},
"writable" : {
"type" : "boolean"
}
}
}
propertyType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "IDENTIFIER", "TEXT", "NUMBER", "INTEGER", "BOOLEAN", "EMAIL", "PASSWORD", "URL", "DATE", "PHONENUMBER", "GEOLOCATION", "COLOR", "CONSTANT", "COMPLEX", "COLLECTION", "REFERENCE" ]
}
schema
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"apiEndpoint" : {
"type" : "string"
},
"authorities" : {
"type" : "array",
"items" : {
"$ref" : "authority.json"
}
},
"collectionName" : {
"type" : "string"
},
"dataReadShareable" : {
"type" : "boolean"
},
"dataShareable" : {
"type" : "boolean"
},
"dataWriteShareable" : {
"type" : "boolean"
},
"defaultPrivate" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"embeddedObject" : {
"type" : "boolean"
},
"favoritable" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"identifiableObject" : {
"type" : "boolean"
},
"implicitPrivateAuthority" : {
"type" : "boolean"
},
"klass" : {
"type" : "string"
},
"metadata" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"nameableObject" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"order" : {
"type" : "integer"
},
"persisted" : {
"type" : "boolean"
},
"plural" : {
"type" : "string"
},
"properties" : {
"type" : "array",
"items" : {
"$ref" : "property.json"
}
},
"references" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeApiEndpoint" : {
"type" : "string"
},
"secondaryMetadata" : {
"type" : "boolean"
},
"shareable" : {
"type" : "boolean"
},
"singular" : {
"type" : "string"
},
"subscribable" : {
"type" : "boolean"
},
"subscribableObject" : {
"type" : "boolean"
},
"translatable" : {
"type" : "boolean"
}
}
}
schemas
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"schemas" : {
"type" : "array",
"items" : {
"$ref" : "schema.json"
}
}
}
}
include_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FALSE", "TRUE", "AUTO" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUTO", "NONE", "IS_EMPTY", "IS_NOT_EMPTY", "SIZE", "MEMBER", "NOT_MEMBER", "IDS", "ID_OBJECTS", "PLUCK" ]
}
userDto
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
}
}
authorities
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "F_TRACKED_ENTITY_INSTANCE_SEARCH_IN_ALL_ORGUNITS", "F_TEI_CASCADE_DELETE", "F_ENROLLMENT_CASCADE_DELETE", "F_EDIT_EXPIRED", "F_IGNORE_TRACKER_REQUIRED_VALUE_VALIDATION", "F_SKIP_DATA_IMPORT_AUDIT", "F_METADATA_EXPORT", "F_USER_VIEW" ]
}
authority
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"type" : {
"$ref" : "authorityType.json"
}
}
}
authorityType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "DATA_CREATE", "CREATE_PUBLIC", "CREATE_PRIVATE", "EXTERNALIZE", "READ", "DATA_READ", "UPDATE", "DELETE" ]
}
recaptchaResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"challenge_ts" : {
"type" : "string"
},
"error-codes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hostname" : {
"type" : "string"
},
"success" : {
"type" : "boolean"
}
}
}
restoreOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RECOVER_PASSWORD_OPTION", "INVITE_WITH_USERNAME_CHOICE", "INVITE_WITH_DEFINED_USERNAME" ]
}
restoreType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RECOVER_PASSWORD", "INVITE" ]
}
access
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"data" : {
"$ref" : "accessData.json"
},
"delete" : {
"type" : "boolean"
},
"externalize" : {
"type" : "boolean"
},
"manage" : {
"type" : "boolean"
},
"read" : {
"type" : "boolean"
},
"update" : {
"type" : "boolean"
},
"write" : {
"type" : "boolean"
}
}
}
accessData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"read" : {
"type" : "boolean"
},
"write" : {
"type" : "boolean"
}
}
}
permission
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "READ", "WRITE", "DATA_READ", "DATA_WRITE" ]
}
apiToken
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "ipAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "IpAllowedList"
}
},
"required" : [ "type" ]
}, {
"$ref" : "refererAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "RefererAllowedList"
}
},
"required" : [ "type" ]
}, {
"$ref" : "methodAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "MethodAllowedList"
}
},
"required" : [ "type" ]
} ]
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"expire" : {
"type" : "integer"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "apiTokenType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"version" : {
"type" : "integer"
}
}
}
apiTokenType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"const" : "PERSONAL_ACCESS_TOKEN"
}
oAuth2Client
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cid" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"grantTypes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"redirectUris" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"secret" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
settingKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UI_LOCALE", "DB_LOCALE", "ANALYSIS_DISPLAY_PROPERTY", "ANALYSIS_DIGIT_GROUP_SEPARATOR", "CURRENT_DOMAIN_TYPE", "TRACKER_DASHBOARD_LAYOUT", "APPLICATION_TITLE", "APPLICATION_INTRO", "APPLICATION_NOTIFICATION", "APPLICATION_FOOTER", "APPLICATION_RIGHT_FOOTER", "FLAG", "FLAG_IMAGE", "START_MODULE", "START_MODULE_ENABLE_LIGHT_WEIGHT", "FACTOR_OF_DEVIATION", "EMAIL_HOST_NAME", "EMAIL_PORT", "EMAIL_USERNAME", "EMAIL_TLS", "EMAIL_SENDER", "EMAIL_PASSWORD", "MIN_PASSWORD_LENGTH", "MAX_PASSWORD_LENGTH", "SMS_CONFIG", "CACHE_STRATEGY", "CACHEABILITY", "ANALYTICS_FINANCIAL_YEAR_START", "PHONE_NUMBER_AREA_CODE", "MULTI_ORGANISATION_UNIT_FORMS", "CONFIGURATION", "ACCOUNT_RECOVERY", "LOCK_MULTIPLE_FAILED_LOGINS", "GOOGLE_ANALYTICS_UA", "CREDENTIALS_EXPIRES", "CREDENTIALS_EXPIRY_ALERT", "ACCOUNT_EXPIRES_IN_DAYS", "ACCOUNT_EXPIRY_ALERT", "SELF_REGISTRATION_NO_RECAPTCHA", "RECAPTCHA_SECRET", "RECAPTCHA_SITE", "CAN_GRANT_OWN_USER_AUTHORITY_GROUPS", "IGNORE_ANALYTICS_APPROVAL_YEAR_THRESHOLD", "ANALYTICS_MAX_LIMIT", "INCLUDE_ZERO_VALUES_IN_ANALYTICS", "SQL_VIEW_MAX_LIMIT", "RESPECT_META_DATA_START_END_DATES_IN_ANALYTICS_TABLE_EXPORT", "SKIP_DATA_TYPE_VALIDATION_IN_ANALYTICS_TABLE_EXPORT", "CUSTOM_LOGIN_PAGE_LOGO", "CUSTOM_TOP_MENU_LOGO", "ANALYTICS_MAINTENANCE_MODE", "DATABASE_SERVER_CPUS", "LAST_SUCCESSFUL_ANALYTICS_TABLES_RUNTIME", "LAST_SUCCESSFUL_LATEST_ANALYTICS_PARTITION_RUNTIME", "LAST_MONITORING_RUN", "LAST_SUCCESSFUL_DATA_VALUE_SYNC", "LAST_SUCCESSFUL_EVENT_DATA_SYNC", "LAST_SUCCESSFUL_COMPLETE_DATA_SET_REGISTRATION_SYNC", "SKIP_SYNCHRONIZATION_FOR_DATA_CHANGED_BEFORE", "LAST_SUCCESSFUL_ANALYTICS_TABLES_UPDATE", "LAST_SUCCESSFUL_LATEST_ANALYTICS_PARTITION_UPDATE", "LAST_SUCCESSFUL_RESOURCE_TABLES_UPDATE", "LAST_SUCCESSFUL_SYSTEM_MONITORING_PUSH", "LAST_SUCCESSFUL_MONITORING", "NEXT_ANALYTICS_TABLE_UPDATE", "HELP_PAGE_LINK", "ACCEPTANCE_REQUIRED_FOR_APPROVAL", "SYSTEM_NOTIFICATIONS_EMAIL", "ANALYSIS_RELATIVE_PERIOD", "REQUIRE_ADD_TO_VIEW", "ALLOW_OBJECT_ASSIGNMENT", "USE_CUSTOM_LOGO_FRONT", "USE_CUSTOM_LOGO_BANNER", "METADATA_REPO_URL", "DATA_IMPORT_STRICT_PERIODS", "DATA_IMPORT_STRICT_DATA_ELEMENTS", "DATA_IMPORT_STRICT_CATEGORY_OPTION_COMBOS", "DATA_IMPORT_STRICT_ORGANISATION_UNITS", "DATA_IMPORT_STRICT_ATTRIBUTE_OPTION_COMBOS", "DATA_IMPORT_REQUIRE_CATEGORY_OPTION_COMBO", "DATA_IMPORT_REQUIRE_ATTRIBUTE_OPTION_COMBO", "CUSTOM_JS", "CUSTOM_CSS", "CALENDAR", "DATE_FORMAT", "STYLE", "REMOTE_INSTANCE_URL", "REMOTE_INSTANCE_USERNAME", "REMOTE_INSTANCE_PASSWORD", "GOOGLE_MAPS_API_KEY", "BING_MAPS_API_KEY", "LAST_SUCCESSFUL_METADATA_SYNC", "METADATAVERSION_ENABLED", "METADATA_FAILED_VERSION", "METADATA_LAST_FAILED_TIME", "LAST_SUCCESSFUL_SCHEDULED_PROGRAM_NOTIFICATIONS", "LAST_SUCCESSFUL_SCHEDULED_DATASET_NOTIFICATIONS", "REMOTE_METADATA_VERSION", "SYSTEM_METADATA_VERSION", "STOP_METADATA_SYNC", "FILE_RESOURCE_RETENTION_STRATEGY", "MAX_REMOTE_SERVER_AVAILABILITY_CHECK_ATTEMPTS", "MAX_SYNC_ATTEMPTS", "DELAY_BETWEEN_REMOTE_SERVER_AVAILABILITY_CHECK_ATTEMPTS", "LAST_SUCCESSFUL_DATA_STATISTICS", "ANALYTICS_HIDE_DAILY_PERIODS", "ANALYTICS_HIDE_WEEKLY_PERIODS", "ANALYTICS_HIDE_BIWEEKLY_PERIODS", "ANALYTICS_HIDE_MONTHLY_PERIODS", "ANALYTICS_HIDE_BIMONTHLY_PERIODS", "GATHER_ANALYTICAL_OBJECT_STATISTICS_IN_DASHBOARD_VIEWS", "COUNT_PASSIVE_DASHBOARD_VIEWS_IN_USAGE_ANALYTICS", "DASHBOARD_CONTEXT_MENU_ITEM_SWITCH_VIEW_TYPE", "DASHBOARD_CONTEXT_MENU_ITEM_OPEN_IN_RELEVANT_APP", "DASHBOARD_CONTEXT_MENU_ITEM_SHOW_INTERPRETATIONS_AND_DETAILS", "DASHBOARD_CONTEXT_MENU_ITEM_VIEW_FULLSCREEN", "RULE_ENGINE_ASSIGN_OVERWRITE", "ANALYTICS_CACHE_PROGRESSIVE_TTL_FACTOR", "ANALYTICS_CACHE_TTL_MODE" ]
}
styleObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"path" : {
"type" : "string"
}
}
}
accessObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
cascadeSharingReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"countUpdatedDashboardItems" : {
"type" : "integer"
},
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"updateObjects" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "idObject_.json"
}
}
}
}
}
cascadeSharingReportBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"countUpdatedDashboardItems(int)" : {
"$ref" : "#"
},
"errorReports(List<ErrorReport>)" : {
"$ref" : "#"
},
"updateObjects(Map<String, Set<IdObject>>)" : {
"$ref" : "#"
}
}
}
idObject_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
completenessMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL_DATAVALUE", "AT_LEAST_ONE_DATAVALUE", "DO_NOT_MARK_COMPLETE" ]
}
sMSCommand
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"codeValueSeparator" : {
"type" : "string"
},
"completenessMethod" : {
"$ref" : "completenessMethod.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"currentPeriodUsedForReporting" : {
"type" : "boolean"
},
"dataset" : {
"$ref" : "dataSet.json"
},
"defaultMessage" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"moreThanOneOrgUnitMessage" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"noUserMessage" : {
"type" : "string"
},
"parserType" : {
"$ref" : "parserType.json"
},
"program" : {
"$ref" : "program.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"receivedMessage" : {
"type" : "string"
},
"separator" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"smsCodes" : {
"type" : "array",
"items" : {
"$ref" : "sMSCode.json"
}
},
"specialCharacters" : {
"type" : "array",
"items" : {
"$ref" : "sMSSpecialCharacter.json"
}
},
"successMessage" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroup" : {
"$ref" : "userGroup.json"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"wrongFormatMessage" : {
"type" : "string"
}
}
}
sMSSpecialCharacter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
sMSCode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"formula" : {
"type" : "string"
},
"optionId" : {
"type" : "integer"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
}
}
}
clickatellGatewayConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"const" : "clickatell"
}
},
"required" : [ "type" ]
}
contentType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APPLICATION_JSON", "APPLICATION_XML", "TEXT_PLAIN", "FORM_URL_ENCODED" ]
}
genericHttpGatewayConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"const" : "http"
}
},
"required" : [ "type" ]
}
incomingSms
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"gatewayid" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"originator" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"receiveddate" : {
"type" : "string",
"format" : "date-time"
},
"sentdate" : {
"type" : "string",
"format" : "date-time"
},
"sharing" : {
"$ref" : "sharing.json"
},
"smsencoding" : {
"$ref" : "smsMessageEncoding.json"
},
"smsstatus" : {
"$ref" : "smsMessageStatus.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
smsMessageEncoding
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ENC7BIT", "ENC8BIT", "ENCUCS2", "ENCCUSTOM" ]
}
smsMessageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCOMING", "PROCESSING", "UNHANDLED", "FAILED", "PROCESSED", "SENT" ]
}
relationshipDir
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FROM", "TO" ]
}
bulkSmsRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
bulkSmsRequestEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"to" : {
"type" : "array",
"items" : {
"$ref" : "bulkSmsRecipient.json"
}
}
}
}
clickatellRequestEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"content" : {
"type" : "string"
},
"to" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
clickatellResponseEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
gatewayResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "SENT", "FAILED", "PENDING", "SERVICE_NOT_AVAILABLE", "ENCODING_FAILURE", "PROCESSING", "QUEUED", "NO_GATEWAY_CONFIGURATION", "NO_DEFAULT_GATEWAY", "AUTHENTICATION_FAILED", "NO_RECIPIENT", "SMS_DISABLED", "SMPP_SESSION_FAILURE", "RESULT_CODE_0", "RESULT_CODE_1", "RESULT_CODE_22", "RESULT_CODE_23", "RESULT_CODE_24", "RESULT_CODE_25", "RESULT_CODE_26", "RESULT_CODE_27", "RESULT_CODE_28", "RESULT_CODE_40", "RESULT_CODE_201", "RESULT_CODE_403", "RESULT_CODE_200", "RESULT_CODE_202", "RESULT_CODE_207", "RESULT_CODE_400", "RESULT_CODE_401", "RESULT_CODE_402", "RESULT_CODE_404", "RESULT_CODE_405", "RESULT_CODE_410", "RESULT_CODE_429", "RESULT_CODE_503", "RESULT_CODE_504" ]
}
outboundSms
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"date" : {
"type" : "string",
"format" : "date-time"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"message" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"recipients" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"sender" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "outboundSmsStatus.json"
},
"subject" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
outboundSmsStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OUTBOUND", "SENT", "ERROR", "PENDING", "SCHEDULED", "DELIVERED", "FAILED" ]
}
submissionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SINGLE", "BATCH" ]
}
parserType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "KEY_VALUE_PARSER", "J2ME_PARSER", "ALERT_PARSER", "UNREGISTERED_PARSER", "TRACKED_ENTITY_REGISTRATION_PARSER", "PROGRAM_STAGE_DATAENTRY_PARSER", "EVENT_REGISTRATION_PARSER" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "USER", "TRACKED_ENTITY_TYPE", "TRACKED_ENTITY_ATTRIBUTE", "PROGRAM", "ORGANISATION_UNIT", "DATA_ELEMENT", "CATEGORY_OPTION_COMBO", "DATASET", "PROGRAM_STAGE", "EVENT", "ENROLLMENT", "TRACKED_ENTITY_INSTANCE", "RELATIONSHIP", "RELATIONSHIP_TYPE" ]
}
smsEnrollmentStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
smsEventStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "VISITED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
submissionType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE_DATASET", "DELETE", "ENROLLMENT", "RELATIONSHIP", "SIMPLE_EVENT", "TRACKER_EVENT" ]
}
valueType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INT", "FLOAT", "DATE", "BOOL", "STRING" ]
}
smsResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "WARN_DVERR", "WARN_DVEMPTY", "WARN_AVEMPTY", "UNKNOWN_ERROR", "HEADER_ERROR", "READ_ERROR", "INVALID_USER", "INVALID_ORGUNIT", "INVALID_PROGRAM", "INVALID_TETYPE", "INVALID_DATASET", "INVALID_PERIOD", "INVALID_AOC", "INVALID_TEI", "INVALID_STAGE", "INVALID_EVENT", "INVALID_RELTYPE", "INVALID_ENROLL", "INVALID_ATTRIB", "USER_NOTIN_OU", "OU_NOTIN_PROGRAM", "OU_NOTIN_DATASET", "ENROLL_FAILED", "DATASET_LOCKED", "MULTI_PROGRAMS", "MULTI_STAGES", "NO_ENROLL", "NULL_ATTRIBVAL", "ENROLL_EXIST" ]
}
sqlView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cacheStrategy" : {
"$ref" : "cacheStrategy.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sqlQuery" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "sqlViewType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
sqlViewType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VIEW", "MATERIALIZED_VIEW", "QUERY" ]
}
systemJob
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FILE_RESOURCE", "DATA_STATISTICS", "VALIDATION_RESULTS_NOTIFICATION", "CREDENTIALS_EXPIRY_ALERT", "ACCOUNT_EXPIRY_ALERT", "DATA_SET_NOTIFICATION", "REMOVE_EXPIRED_OR_USED_RESERVED_VALUES", "LEADER_ELECTION" ]
}
systemInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"buildTime" : {
"type" : "string",
"format" : "date-time"
},
"calendar" : {
"type" : "string"
},
"clusterHostname" : {
"type" : "string"
},
"contextPath" : {
"type" : "string"
},
"cpuCores" : {
"type" : "integer"
},
"databaseInfo" : {
"$ref" : "databaseInfo.json"
},
"dateFormat" : {
"type" : "string"
},
"emailConfigured" : {
"type" : "boolean"
},
"encryption" : {
"type" : "boolean"
},
"environmentVariable" : {
"type" : "string"
},
"externalDirectory" : {
"type" : "string"
},
"fileStoreProvider" : {
"type" : "string"
},
"instanceBaseUrl" : {
"type" : "string"
},
"intervalSinceLastAnalyticsTablePartitionSuccess" : {
"type" : "string"
},
"intervalSinceLastAnalyticsTableSuccess" : {
"type" : "string"
},
"isMetadataVersionEnabled" : {
"type" : "boolean"
},
"jasperReportsVersion" : {
"type" : "string"
},
"javaOpts" : {
"type" : "string"
},
"javaVendor" : {
"type" : "string"
},
"javaVersion" : {
"type" : "string"
},
"lastAnalyticsTablePartitionRuntime" : {
"type" : "string"
},
"lastAnalyticsTablePartitionSuccess" : {
"type" : "string",
"format" : "date-time"
},
"lastAnalyticsTableRuntime" : {
"type" : "string"
},
"lastAnalyticsTableSuccess" : {
"type" : "string",
"format" : "date-time"
},
"lastMetadataVersionSyncAttempt" : {
"type" : "string",
"format" : "date-time"
},
"lastSystemMonitoringSuccess" : {
"type" : "string",
"format" : "date-time"
},
"memoryInfo" : {
"type" : "string"
},
"metadataSyncEnabled" : {
"type" : "boolean"
},
"nodeId" : {
"type" : "string"
},
"osArchitecture" : {
"type" : "string"
},
"osName" : {
"type" : "string"
},
"osVersion" : {
"type" : "string"
},
"readOnlyMode" : {
"type" : "string"
},
"readReplicaCount" : {
"type" : "integer"
},
"redisEnabled" : {
"type" : "boolean"
},
"redisHostname" : {
"type" : "string"
},
"revision" : {
"type" : "string"
},
"serverDate" : {
"type" : "string",
"format" : "date-time"
},
"serverTimeZoneDisplayName" : {
"type" : "string"
},
"serverTimeZoneId" : {
"type" : "string"
},
"systemId" : {
"type" : "string"
},
"systemMetadataVersion" : {
"type" : "string"
},
"systemMonitoringUrl" : {
"type" : "string"
},
"systemName" : {
"type" : "string"
},
"userAgent" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
}
}
databaseInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"databaseVersion" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"spatialSupport" : {
"type" : "boolean"
},
"url" : {
"type" : "string"
},
"user" : {
"type" : "string"
}
}
}
listGrid
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"headerWidth" : {
"type" : "integer"
},
"headers" : {
"type" : "array",
"items" : {
"$ref" : "gridHeader.json"
}
},
"height" : {
"type" : "integer"
},
"metaData" : {
"type" : "object"
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : { }
}
},
"subtitle" : {
"type" : "string"
},
"table" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"width" : {
"type" : "integer"
}
}
}
notification
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"category" : {
"$ref" : "jobType.json"
},
"completed" : {
"type" : "boolean"
},
"id" : {
"type" : "string"
},
"level" : {
"$ref" : "notificationLevel.json"
},
"message" : {
"type" : "string"
},
"time" : {
"type" : "string",
"format" : "date-time"
},
"uid" : {
"type" : "string"
}
}
}
notificationLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OFF", "DEBUG", "INFO", "WARN", "ERROR" ]
}
textPattern
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ownerObject" : {
"$ref" : "objects.json"
},
"ownerUid" : {
"type" : "string"
},
"segments" : {
"type" : "array",
"items" : {
"$ref" : "textPatternSegment.json"
}
}
}
}
textPatternMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "RANDOM", "SEQUENTIAL", "ORG_UNIT_CODE", "CURRENT_DATE" ]
}
textPatternSegment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"method" : {
"$ref" : "textPatternMethod.json"
},
"parameter" : {
"type" : "string"
}
}
}
trackedEntityAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"confidential" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInListNoProgram" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayOnVisitSchedule" : {
"type" : "boolean"
},
"displayShortName" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldMask" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"generated" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"inherit" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetValue" : {
"type" : "boolean"
},
"orgunitScope" : {
"type" : "boolean"
},
"pattern" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipSynchronization" : {
"type" : "boolean"
},
"sortOrderInListNoProgram" : {
"type" : "integer"
},
"sortOrderInVisitSchedule" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"unique" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
trackedEntityAttributeDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
}
}
}
trackedEntityDataElementDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElement" : {
"$ref" : "dataElement.json"
},
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"programStage" : {
"$ref" : "programStage.json"
}
}
}
trackedEntityInstance_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"inactive" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"potentialDuplicate" : {
"type" : "boolean"
},
"programInstances" : {
"type" : "array",
"items" : {
"$ref" : "programInstance.json"
}
},
"programOwners" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramOwner.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityAttributeValues" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeValue.json"
}
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
orderColumn
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKEDENTITY", "CREATED", "CREATED_AT", "CREATED_AT_CLIENT", "UPDATED_AT", "UPDATED_AT_CLIENT", "ENROLLED_AT", "INACTIVE" ]
}
trackedEntityProgramIndicatorDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
}
}
}
trackedEntityProgramOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
trackedEntityType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowAuditLog" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"maxTeiCountToReturn" : {
"type" : "integer"
},
"minAttributesRequiredToSearch" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityTypeAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityTypeAttribute.json"
}
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
trackedEntityTypeAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayInList" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"searchable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
trackedEntityAttributeValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"value" : {
"type" : "string"
}
}
}
trackedEntityAttributeValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"auditType" : {
"$ref" : "auditType_.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"modifiedBy" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"value" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"commentText" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"creator" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
trackedEntityDataValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"auditType" : {
"$ref" : "auditType_.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"modifiedBy" : {
"type" : "string"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"value" : {
"type" : "string"
}
}
}
eventFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUserMode" : {
"$ref" : "assignedUserSelectionMode.json"
},
"assignedUsers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"eventCreatedPeriod" : {
"$ref" : "filterPeriod.json"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"programStage" : {
"type" : "string"
}
}
}
filterPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"periodFrom" : {
"type" : "integer"
},
"periodTo" : {
"type" : "integer"
}
}
}
trackedEntityInstanceFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"enrollmentCreatedPeriod" : {
"$ref" : "filterPeriod.json"
},
"enrollmentStatus" : {
"$ref" : "programStatus.json"
},
"eventFilters" : {
"type" : "array",
"items" : {
"$ref" : "eventFilter.json"
}
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followup" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
translation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"locale" : {
"type" : "string"
},
"property" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
translationProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORT_NAME", "DESCRIPTION", "FORM_NAME", "NUMERATOR_DESCRIPTION", "DENOMINATOR_DESCRIPTION", "RELATIONSHIP_FROM_TO_NAME", "RELATIONSHIP_TO_FROM_NAME", "INSTRUCTION", "INCIDENT_DATE_LABEL", "ENROLLMENT_DATE_LABEL", "EXECUTION_DATE_LABEL", "DUE_DATE_LABEL", "CONTENT" ]
}
passwordValidationError
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PASSWORD_IS_MANDATORY", "PASSWORD_TOO_LONG_TOO_SHORT", "PASSWORD_MUST_HAVE_DIGIT", "PASSWORD_MUST_HAVE_UPPER", "PASSWORD_MUST_HAVE_SPECIAL", "PASSWORD_CONTAINS_RESERVED_WORD", "PASSWORD_CONTAINS_NAME_OR_EMAIL", "PASSWORD_ALREADY_USED_BEFORE" ]
}
user
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"avatar" : {
"$ref" : "fileResource.json"
},
"birthday" : {
"type" : "string",
"format" : "date-time"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "#"
},
"dataViewMaxOrganisationUnitLevel" : {
"type" : "integer"
},
"dataViewOrganisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"displayName" : {
"type" : "string"
},
"education" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"employer" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"facebookMessenger" : {
"type" : "string"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"firstName" : {
"type" : "string"
},
"gender" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interests" : {
"type" : "string"
},
"introduction" : {
"type" : "string"
},
"jobTitle" : {
"type" : "string"
},
"languages" : {
"type" : "string"
},
"lastCheckedInterpretations" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "#"
},
"name" : {
"type" : "string"
},
"nationality" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"phoneNumber" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skype" : {
"type" : "string"
},
"surname" : {
"type" : "string"
},
"teiSearchOrganisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"telegram" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"twitter" : {
"type" : "string"
},
"user" : {
"$ref" : "#"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userCredentials" : {
"$ref" : "userCredentials.json"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"welcomeMessage" : {
"type" : "string"
},
"whatsApp" : {
"type" : "string"
}
}
}
userAccess
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"userUid" : {
"type" : "string"
},
"displayName()" : {
"type" : "string"
}
}
}
userAuthorityGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
userCredentials
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accountExpiry" : {
"type" : "string",
"format" : "date-time"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"catDimensionConstraints" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"code" : {
"type" : "string"
},
"cogsDimensionConstraints" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"disabled" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"externalAuth" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"invitation" : {
"type" : "boolean"
},
"lastLogin" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"ldapId" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"openId" : {
"type" : "string"
},
"password" : {
"type" : "string",
"writeOnly" : true
},
"passwordLastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"publicAccess" : {
"type" : "string"
},
"selfRegistered" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"twoFA" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userInfo" : {
"$ref" : "user.json"
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"username" : {
"type" : "string"
}
}
}
userGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"managedByGroups" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"managedGroups" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
userGroupAccess
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"userGroupUid" : {
"type" : "string"
},
"displayName()" : {
"type" : "string"
}
}
}
userInvitationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "ALL", "EXPIRED" ]
}
userSettingKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "STYLE", "MESSAGE_EMAIL_NOTIFICATION", "MESSAGE_SMS_NOTIFICATION", "UI_LOCALE", "DB_LOCALE", "ANALYSIS_DISPLAY_PROPERTY", "TRACKER_DASHBOARD_LAYOUT" ]
}
users
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
sharing
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"external" : {
"type" : "boolean"
},
"owner" : {
"type" : "string"
},
"public" : {
"type" : "string"
},
"userGroups" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "userGroupAccess_.json"
}
},
"users" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "userAccess_.json"
}
}
}
}
sharingBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"external(boolean)" : {
"$ref" : "#"
},
"owner(String)" : {
"$ref" : "#"
},
"public(String)" : {
"$ref" : "#"
},
"userGroups(Map<String, UserGroupAccess>)" : {
"$ref" : "#"
},
"users(Map<String, UserAccess>)" : {
"$ref" : "#"
}
}
}
userAccess_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
userGroupAccess_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
userKeyJsonValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "string"
}
}
}
importance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "HIGH", "MEDIUM", "LOW" ]
}
validationResult
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dayInPeriod" : {
"type" : "integer"
},
"id" : {
"type" : "integer"
},
"leftsideValue" : {
"type" : "number"
},
"notificationSent" : {
"type" : "boolean"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"rightsideValue" : {
"type" : "number"
},
"validationRule" : {
"$ref" : "validationRule.json"
}
}
}
validationRule
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInstruction" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"importance" : {
"$ref" : "importance.json"
},
"instruction" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leftSide" : {
"$ref" : "expression.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "validationNotificationTemplate.json"
}
},
"operator" : {
"$ref" : "operator.json"
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"rightSide" : {
"$ref" : "expression.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipFormValidation" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"$ref" : "validationRuleGroup.json"
}
}
}
}
validationRuleGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
validationRunType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INTERACTIVE", "SCHEDULED" ]
}
validationSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"commentRequiredViolations" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"validationRuleViolations" : {
"type" : "array",
"items" : {
"$ref" : "validationResult.json"
}
}
}
}
validationNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"sendStrategy" : {
"$ref" : "sendStrategy.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
validationRuleTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RULE_NAME", "DESCRIPTION", "OPERATOR", "IMPORTANCE", "LEFT_SIDE_DESCRIPTION", "RIGHT_SIDE_DESCRIPTION", "LEFT_SIDE_VALUE", "RIGHT_SIDE_VALUE", "ORG_UNIT_NAME", "PERIOD", "CURRENT_DATE" ]
}
validationRuleTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RULE_NAME", "DESCRIPTION", "OPERATOR", "IMPORTANCE", "LEFT_SIDE_DESCRIPTION", "RIGHT_SIDE_DESCRIPTION", "LEFT_SIDE_VALUE", "RIGHT_SIDE_VALUE", "ORG_UNIT_NAME", "PERIOD", "CURRENT_DATE" ]
}
axis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"axis" : {
"type" : "integer"
},
"dimensionalItem" : {
"type" : "string"
}
}
}
axisType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DOMAIN", "RANGE" ]
}
axisV2
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"baseLine" : {
"$ref" : "line.json"
},
"decimals" : {
"type" : "integer"
},
"index" : {
"type" : "integer"
},
"label" : {
"$ref" : "styledObject.json"
},
"maxValue" : {
"type" : "integer"
},
"minValue" : {
"type" : "integer"
},
"steps" : {
"type" : "integer"
},
"targetLine" : {
"$ref" : "line.json"
},
"title" : {
"$ref" : "styledObject.json"
},
"type" : {
"$ref" : "axisType.json"
}
}
}
legendDefinitions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"set" : {
"$ref" : "legendSet.json"
},
"showKey" : {
"type" : "boolean"
},
"strategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"style" : {
"$ref" : "legendDisplayStyle.json"
}
}
}
line
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"title" : {
"$ref" : "styledObject.json"
},
"value" : {
"type" : "integer"
}
}
}
normalizedOutlierMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"const" : "Y_RESIDUALS_LINEAR"
}
outlierAnalysis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"extremeLines" : {
"$ref" : "outlierLine.json"
},
"normalizationMethod" : {
"$ref" : "normalizedOutlierMethod.json"
},
"outlierMethod" : {
"$ref" : "outlierMethod.json"
},
"thresholdFactor" : {
"type" : "number"
}
}
}
outlierLine
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"value" : {
"type" : "number"
}
}
}
outlierMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "IQR", "STANDARD_Z_SCORE", "MODIFIED_Z_SCORE" ]
}
reportingParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"grandParentOrganisationUnit" : {
"type" : "boolean"
},
"organisationUnit" : {
"type" : "boolean"
},
"parentOrganisationUnit" : {
"type" : "boolean"
},
"reportingPeriod" : {
"type" : "boolean"
}
}
}
series
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"axis" : {
"type" : "integer"
},
"dimensionItem" : {
"type" : "string"
},
"type" : {
"$ref" : "visualizationType.json"
}
}
}
seriesKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"hidden" : {
"type" : "boolean"
},
"label" : {
"$ref" : "styledObject.json"
}
}
}
simpleVisualizationView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
styledObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fontStyle" : {
"$ref" : "fontStyle.json"
},
"text" : {
"type" : "string"
},
"textMode" : {
"$ref" : "textMode.json"
}
}
}
textMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUTO", "CUSTOM" ]
}
visualization
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"axes" : {
"type" : "array",
"items" : {
"$ref" : "axisV2.json"
}
},
"baseLineLabel" : {
"type" : "string",
"readOnly" : true
},
"baseLineValue" : {
"type" : "number",
"readOnly" : true
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"colSubTotals" : {
"type" : "boolean"
},
"colTotals" : {
"type" : "boolean"
},
"colorSet" : {
"type" : "string"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDensity" : {
"$ref" : "displayDensity.json"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string",
"readOnly" : true
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"fixColumnHeaders" : {
"type" : "boolean"
},
"fixRowHeaders" : {
"type" : "boolean"
},
"fontSize" : {
"$ref" : "fontSize.json"
},
"fontStyle" : {
"$ref" : "visualizationFontStyle.json"
},
"formName" : {
"type" : "string"
},
"hideEmptyColumns" : {
"type" : "boolean"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideEmptyRows" : {
"type" : "boolean"
},
"hideLegend" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legend" : {
"$ref" : "legendDefinitions.json"
},
"measureCriteria" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"numberType" : {
"$ref" : "numberType.json"
},
"optionalAxes" : {
"type" : "array",
"items" : {
"$ref" : "axis.json"
}
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outlierAnalysis" : {
"$ref" : "outlierAnalysis.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer",
"readOnly" : true
},
"rangeAxisLabel" : {
"type" : "string",
"readOnly" : true
},
"rangeAxisMaxValue" : {
"type" : "number",
"readOnly" : true
},
"rangeAxisMinValue" : {
"type" : "number",
"readOnly" : true
},
"rangeAxisSteps" : {
"type" : "integer",
"readOnly" : true
},
"regression" : {
"type" : "boolean"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"reportingParams" : {
"$ref" : "reportingParams.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rowSubTotals" : {
"type" : "boolean"
},
"rowTotals" : {
"type" : "boolean"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"series" : {
"type" : "array",
"items" : {
"$ref" : "series.json"
}
},
"seriesKey" : {
"$ref" : "seriesKey.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"showDimensionLabels" : {
"type" : "boolean"
},
"showHierarchy" : {
"type" : "boolean"
},
"skipRounding" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string",
"readOnly" : true
},
"targetLineValue" : {
"type" : "number",
"readOnly" : true
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"visualizationPeriodName" : {
"type" : "string"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
visualizationFontStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"baseLineLabel" : {
"$ref" : "fontStyle.json"
},
"categoryAxisLabel" : {
"$ref" : "fontStyle.json"
},
"horizontalAxisTitle" : {
"$ref" : "fontStyle.json"
},
"legend" : {
"$ref" : "fontStyle.json"
},
"seriesAxisLabel" : {
"$ref" : "fontStyle.json"
},
"targetLineLabel" : {
"$ref" : "fontStyle.json"
},
"verticalAxisTitle" : {
"$ref" : "fontStyle.json"
},
"visualizationSubtitle" : {
"$ref" : "fontStyle.json"
},
"visualizationTitle" : {
"$ref" : "fontStyle.json"
}
}
}
visualizationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COLUMN", "STACKED_COLUMN", "BAR", "STACKED_BAR", "LINE", "AREA", "STACKED_AREA", "PIE", "RADAR", "GAUGE", "YEAR_OVER_YEAR_LINE", "YEAR_OVER_YEAR_COLUMN", "SINGLE_VALUE", "PIVOT_TABLE", "SCATTER", "BUBBLE" ]
}
sortDirection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC", "IASC", "IDESC" ]
}
jsonNodeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OBJECT", "ARRAY", "STRING", "NUMBER", "BOOLEAN", "NULL" ]
}
geometry
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionItemKeywords
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
forwardingMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
abstractMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
hashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
linkedHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
aggregationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUM", "AVERAGE", "AVERAGE_SUM_ORG_UNIT", "LAST", "LAST_AVERAGE_ORG_UNIT", "LAST_IN_PERIOD", "LAST_IN_PERIOD_AVERAGE_ORG_UNIT", "FIRST", "FIRST_AVERAGE_ORG_UNIT", "COUNT", "STDDEV", "VARIANCE", "MIN", "MAX", "NONE", "CUSTOM", "DEFAULT" ]
}
analyticsCacheTtlMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FIXED", "PROGRESSIVE" ]
}
analyticsFavoriteType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION", "REPORT_TABLE", "CHART", "MAP", "EVENT_REPORT", "EVENT_CHART", "DATASET_REPORT" ]
}
analyticsFinancialYearStartKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FINANCIAL_YEAR_APRIL", "FINANCIAL_YEAR_JULY", "FINANCIAL_YEAR_OCTOBER" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ITEMS", "DIMENSIONS", "PAGER", "ORG_UNIT_HIERARCHY", "ORG_UNIT_NAME_HIERARCHY", "ORG_UNIT_ANCESTORS" ]
}
analyticsTableHook
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"analyticsTableType" : {
"$ref" : "analyticsTableType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"phase" : {
"$ref" : "analyticsTablePhase.json"
},
"publicAccess" : {
"type" : "string"
},
"resourceTableType" : {
"$ref" : "resourceTableType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sql" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
analyticsTablePhase
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RESOURCE_TABLE_POPULATED", "ANALYTICS_TABLE_POPULATED" ]
}
analyticsTableType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_VALUE", "COMPLETENESS", "COMPLETENESS_TARGET", "ORG_UNIT_TARGET", "EVENT", "ENROLLMENT", "VALIDATION_RESULT" ]
}
dataType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NUMERIC", "BOOLEAN", "TEXT" ]
}
eventDataType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATED_VALUES", "EVENTS" ]
}
eventOutputType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT", "TRACKED_ENTITY_INSTANCE" ]
}
numberType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VALUE", "ROW_PERCENTAGE", "COLUMN_PERCENTAGE" ]
}
sortOrder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC" ]
}
userOrgUnitType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_CAPTURE", "DATA_OUTPUT", "TEI_SEARCH" ]
}
cacheType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "IN_MEMORY", "REDIS" ]
}
app
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activities" : {
"$ref" : "appActivities.json"
},
"appState" : {
"$ref" : "appStatus.json"
},
"appStorageSource" : {
"$ref" : "appStorageSource.json"
},
"appType" : {
"$ref" : "appType.json"
},
"app_hub_id" : {
"type" : "string"
},
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"baseUrl" : {
"type" : "string"
},
"bundled" : {
"type" : "boolean"
},
"core_app" : {
"type" : "boolean"
},
"default_locale" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"developer" : {
"$ref" : "appDeveloper.json"
},
"folderName" : {
"type" : "string"
},
"icons" : {
"$ref" : "appIcons.json"
},
"installs_allowed_from" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"key" : {
"type" : "string"
},
"launchUrl" : {
"type" : "string"
},
"launch_path" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"settings" : {
"$ref" : "appSettings.json"
},
"short_name" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
}
}
appActivities
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dhis" : {
"$ref" : "appDhis.json"
}
}
}
appDeveloper
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"company" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"url" : {
"type" : "string"
}
}
}
appDhis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
}
}
}
appIcons
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"128" : {
"type" : "string"
},
"16" : {
"type" : "string"
},
"48" : {
"type" : "string"
}
}
}
appSettings
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dashboardWidget" : {
"$ref" : "dashboardWidgetAppSettings.json"
}
}
}
appStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "INVALID_BUNDLED_APP_OVERRIDE", "INVALID_CORE_APP", "NAMESPACE_TAKEN", "INVALID_ZIP_FORMAT", "MISSING_MANIFEST", "INVALID_MANIFEST_JSON", "INSTALLATION_FAILED", "NOT_FOUND", "MISSING_SYSTEM_BASE_URL", "APPROVED", "PENDING", "NOT_APPROVED", "DELETION_IN_PROGRESS" ]
}
appStorageSource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LOCAL", "JCLOUDS" ]
}
appType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APP", "RESOURCE", "DASHBOARD_WIDGET", "TRACKER_DASHBOARD_WIDGET" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"hideTitle" : {
"type" : "boolean"
}
}
}
messageType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUDIT", "TRACKER_JOB", "TRACKER_SIDE_EFFECT" ]
}
serializableMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"messageType" : {
"$ref" : "messageType.json"
}
}
}
audit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"$ref" : "auditAttributes.json"
},
"auditScope" : {
"$ref" : "auditScope.json"
},
"auditType" : {
"$ref" : "auditType.json"
},
"code" : {
"type" : "string"
},
"createdAt" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"data" : { },
"klass" : {
"type" : "string"
},
"messageType" : {
"$ref" : "messageType.json"
},
"uid" : {
"type" : "string"
}
}
}
auditBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes(AuditAttributes)" : {
"$ref" : "#"
},
"auditScope(AuditScope)" : {
"$ref" : "#"
},
"auditType(AuditType)" : {
"$ref" : "#"
},
"code(String)" : {
"$ref" : "#"
},
"createdAt(LocalDateTime)" : {
"$ref" : "#"
},
"createdBy(String)" : {
"$ref" : "#"
},
"data(Object)" : {
"$ref" : "#"
},
"klass(String)" : {
"$ref" : "#"
},
"uid(String)" : {
"$ref" : "#"
}
}
}
artemisConfigData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"embedded" : {
"$ref" : "artemisEmbeddedConfig.json"
},
"host" : {
"type" : "string"
},
"mode" : {
"$ref" : "artemisMode.json"
},
"port" : {
"type" : "integer"
},
"sendAsync" : {
"type" : "boolean"
}
}
}
artemisEmbeddedConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistence" : {
"type" : "boolean"
},
"security" : {
"type" : "boolean"
}
}
}
artemisMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EMBEDDED", "NATIVE" ]
}
attribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryAttribute" : {
"type" : "boolean"
},
"categoryOptionAttribute" : {
"type" : "boolean"
},
"categoryOptionComboAttribute" : {
"type" : "boolean"
},
"categoryOptionGroupAttribute" : {
"type" : "boolean"
},
"categoryOptionGroupSetAttribute" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"constantAttribute" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementAttribute" : {
"type" : "boolean"
},
"dataElementGroupAttribute" : {
"type" : "boolean"
},
"dataElementGroupSetAttribute" : {
"type" : "boolean"
},
"dataSetAttribute" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"documentAttribute" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorAttribute" : {
"type" : "boolean"
},
"indicatorGroupAttribute" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSetAttribute" : {
"type" : "boolean"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"optionAttribute" : {
"type" : "boolean"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetAttribute" : {
"type" : "boolean"
},
"organisationUnitAttribute" : {
"type" : "boolean"
},
"organisationUnitGroupAttribute" : {
"type" : "boolean"
},
"organisationUnitGroupSetAttribute" : {
"type" : "boolean"
},
"programAttribute" : {
"type" : "boolean"
},
"programIndicatorAttribute" : {
"type" : "boolean"
},
"programStageAttribute" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"sectionAttribute" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"sqlViewAttribute" : {
"type" : "boolean"
},
"trackedEntityAttributeAttribute" : {
"type" : "boolean"
},
"trackedEntityTypeAttribute" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"unique" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userAttribute" : {
"type" : "boolean"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userGroupAttribute" : {
"type" : "boolean"
},
"validationRuleAttribute" : {
"type" : "boolean"
},
"validationRuleGroupAttribute" : {
"type" : "boolean"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
attributeValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"$ref" : "attribute.json"
},
"value" : {
"type" : "string"
}
}
}
audit_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"$ref" : "auditAttributes.json"
},
"auditScope" : {
"$ref" : "auditScope.json"
},
"auditType" : {
"$ref" : "auditType.json"
},
"code" : {
"type" : "string"
},
"createdAt" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
auditBuilder_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes(AuditAttributes)" : {
"$ref" : "#"
},
"auditScope(AuditScope)" : {
"$ref" : "#"
},
"auditType(AuditType)" : {
"$ref" : "#"
},
"code(String)" : {
"$ref" : "#"
},
"createdAt(LocalDateTime)" : {
"$ref" : "#"
},
"createdBy(String)" : {
"$ref" : "#"
},
"klass(String)" : {
"$ref" : "#"
},
"uid(String)" : {
"$ref" : "#"
}
}
}
auditAttributes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
auditScope
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "METADATA", "AGGREGATE", "TRACKER" ]
}
auditType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "READ", "UPDATE", "DELETE", "SEARCH", "SECURITY" ]
}
trackedEntityInstanceAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"accessedBy" : {
"type" : "string"
},
"auditType" : {
"$ref" : "auditType_.json"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"trackedEntityInstance" : {
"type" : "string"
}
}
}
cacheInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"burden" : {
"$ref" : "cacheBurdenInfo.json"
},
"cap" : {
"$ref" : "cacheCapInfo.json"
},
"regions" : {
"type" : "array",
"items" : {
"$ref" : "cacheGroupInfo.json"
}
},
"total" : {
"$ref" : "cacheGroupInfo.json"
}
}
}
cacheBurdenInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"averageEntrySize" : {
"type" : "integer"
},
"averageEntrySizeHumanReadable" : {
"type" : "string"
},
"entries" : {
"type" : "integer"
},
"size" : {
"type" : "integer"
},
"sizeHumanReadable" : {
"type" : "string"
},
"threshold" : {
"type" : "number"
}
}
}
cacheCapInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"capPercentage" : {
"type" : "integer"
},
"hardCapPercentage" : {
"type" : "integer"
},
"softCapPercentage" : {
"type" : "integer"
}
}
}
cacheGroupInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"averageEntrySize" : {
"type" : "integer"
},
"averageEntrySizeHumanReadable" : {
"type" : "string"
},
"burden" : {
"type" : "number"
},
"entries" : {
"type" : "integer"
},
"highBurdenEntries" : {
"type" : "integer"
},
"hits" : {
"type" : "integer"
},
"hitsMissesRatio" : {
"type" : "number"
},
"misses" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"size" : {
"type" : "integer"
},
"sizeHumanReadable" : {
"type" : "string"
}
}
}
cacheType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "IN_MEMORY", "REDIS" ]
}
region
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "analyticsResponse", "defaultObjectCache", "isDataApproved", "allConstantsCache", "inUserOuHierarchy", "isUserViewOuHierHierarchy", "inUserSearchOuHierarchy", "userCaptureOuCountThreshold", "periodIdCache", "userAccountRecoverAttempt", "userFailedLoginAttempt", "programOwner", "programTempOwner", "userIdCache", "currentUserGroupInfoCache", "userSetting", "attrOptionComboIdCache", "systemSetting", "googleAccessToken", "dataItemsPagination", "metadataAttributes", "canDataWriteCocCache", "analyticsSql", "dataElementCache", "propertyTransformerCache", "programHasRulesCache", "programRuleVariablesCache", "userGroupNameCache", "userDisplayNameCache", "programWebHookNotificationTemplateCache", "programStageWebHookNotificationTemplateCache", "pgmOrgUnitAssocCache", "catOptOrgUnitAssocCache", "apiTokensCache" ]
}
dateIntervalType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ISO8601_YEAR", "ISO8601_MONTH", "ISO8601_WEEK", "ISO8601_DAY" ]
}
dateUnitType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "WEEKLY_WEDNESDAY", "WEEKLY_THURSDAY", "WEEKLY_SATURDAY", "WEEKLY_SUNDAY", "BI_WEEKLY", "MONTHLY", "BI_MONTHLY", "QUARTERLY", "SIX_MONTHLY", "SIX_MONTHLY_APRIL", "SIX_MONTHLY_NOVEMBER", "YEARLY", "FINANCIAL_APRIL", "FINANCIAL_JULY", "FINANCIAL_OCTOBER", "FINANCIAL_NOVEMBER" ]
}
category
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryCombo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"default" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skipTotal" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"category" : {
"$ref" : "category.json"
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
}
}
}
categoryOption
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"default" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionCombo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"ignoreApproval" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryOptionGroupSet" : {
"$ref" : "categoryOptionGroupSet.json"
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
}
}
}
accessLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OPEN", "AUDITED", "PROTECTED", "CLOSED" ]
}
analyticsType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE", "EVENT" ]
}
assignedUserSelectionMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CURRENT", "PROVIDED", "NONE", "ANY" ]
}
auditType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "UPDATE", "DELETE", "READ", "SEARCH" ]
}
baseAnalyticalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
}
}
}
baseDataDimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseDimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseDimensionalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseIdentifiableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseLinkableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
}
}
}
baseNameableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
compression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "GZIP", "ZIP" ]
}
dataDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataDimensionItemType" : {
"$ref" : "dataDimensionItemType.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"dataElementOperand" : {
"$ref" : "dataElementOperand.json"
},
"indicator" : {
"$ref" : "indicator.json"
},
"programAttribute" : {
"$ref" : "programTrackedEntityAttributeDimensionItem.json"
},
"programDataElement" : {
"$ref" : "programDataElementDimensionItem.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
},
"reportingRate" : {
"$ref" : "reportingRate.json"
}
}
}
dataDimensionItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR", "DATA_ELEMENT", "DATA_ELEMENT_OPERAND", "REPORTING_RATE", "PROGRAM_INDICATOR", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "VALIDATION_RULE" ]
}
dataDimensionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DISAGGREGATION", "ATTRIBUTE" ]
}
deliveryChannel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SMS", "EMAIL", "HTTP" ]
}
dhisApiVersion
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "V28", "V29", "V30", "V31", "V32", "V33", "V34", "V35", "V36", "V37", "V38", "DEFAULT" ]
}
digitGroupSeparator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMMA", "SPACE", "NONE" ]
}
dimensionItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT", "DATA_ELEMENT_OPERAND", "INDICATOR", "REPORTING_RATE", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "PROGRAM_INDICATOR", "PERIOD", "ORGANISATION_UNIT", "CATEGORY_OPTION", "OPTION_GROUP", "DATA_ELEMENT_GROUP", "ORGANISATION_UNIT_GROUP", "CATEGORY_OPTION_GROUP" ]
}
dimensionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_X", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "PROGRAM_INDICATOR", "DATA_COLLAPSED", "CATEGORY_OPTION_COMBO", "ATTRIBUTE_OPTION_COMBO", "PERIOD", "ORGANISATION_UNIT", "CATEGORY_OPTION_GROUP_SET", "DATA_ELEMENT_GROUP_SET", "ORGANISATION_UNIT_GROUP_SET", "ORGANISATION_UNIT_GROUP", "CATEGORY", "OPTION_GROUP_SET", "VALIDATION_RULE", "STATIC", "ORGANISATION_UNIT_LEVEL" ]
}
displayDensity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMFORTABLE", "NORMAL", "COMPACT", "NONE" ]
}
displayProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORTNAME" ]
}
fallbackCoordinateFieldType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OU_GEOMETRY", "PSI_GEOMETRY" ]
}
fileTypeValueOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"type" : "object",
"properties" : {
"allowedContentTypes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"maxFileSize" : {
"type" : "integer"
},
"version" : {
"type" : "integer"
}
}
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
}
font
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ARIAL", "SANS_SERIF", "VERDANA", "ROBOTO" ]
}
fontSize
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LARGE", "NORMAL", "SMALL" ]
}
fontStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"bold" : {
"type" : "boolean"
},
"font" : {
"$ref" : "font.json"
},
"fontSize" : {
"type" : "integer"
},
"italic" : {
"type" : "boolean"
},
"textAlign" : {
"$ref" : "textAlign.json"
},
"textColor" : {
"type" : "string"
},
"underline" : {
"type" : "boolean"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"column" : {
"type" : "string"
},
"hidden" : {
"type" : "boolean"
},
"legendSet" : {
"type" : "string"
},
"meta" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"optionSet" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
hideEmptyItemStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "BEFORE_FIRST", "AFTER_LAST", "BEFORE_FIRST_AFTER_LAST", "ALL" ]
}
idSchemes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
identifiableObjects
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"additions" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
},
"deletions" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
},
"identifiableObjects" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
}
}
}
identifiableProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "UID", "UUID", "NAME", "CODE", "ATTRIBUTE" ]
}
listMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : { }
}
}
listMapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "listMap.json"
}
}
map4
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "mapMapMap.json"
}
}
mapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
mapMapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "mapMap.json"
}
}
mergeMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MERGE_ALWAYS", "MERGE_IF_NOT_NULL", "MERGE", "REPLACE", "NONE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"code" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"indicatorType" : {
"$ref" : "indicatorType.json"
},
"legendSet" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"totalAggregationType" : {
"$ref" : "totalAggregationType.json"
},
"uid" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
nameableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
notificationTemplateObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
objectStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"color" : {
"type" : "string"
},
"icon" : {
"type" : "string"
}
}
}
objects
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CONSTANT", "DATAELEMENT", "EXTENDEDDATAELEMENT", "DATAELEMENTGROUP", "DATAELEMENTGROUPSET", "INDICATORTYPE", "INDICATOR", "INDICATORGROUP", "INDICATORGROUPSET", "DATASET", "ORGANISATIONUNIT", "ORGANISATIONUNITGROUP", "ORGANISATIONUNITGROUPSET", "ORGANISATIONUNITLEVEL", "VALIDATIONRULE", "PERIOD", "DATAVALUE", "USER", "USERGROUP", "VISUALIZATION", "REPORT", "MAP", "DASHBOARD", "PROGRAM", "PROGRAMSTAGEINSTANCE", "PROGRAMINSTANCE", "TRACKEDENTITYINSTANCE", "TRACKEDENTITYATTRIBUTE" ]
}
organisationUnitSelectionMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SELECTED", "CHILDREN", "DESCENDANTS", "ACCESSIBLE", "CAPTURE", "ALL" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"nextPage" : {
"type" : "string"
},
"page" : {
"type" : "integer"
},
"pageCount" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"prevPage" : {
"type" : "string"
},
"total" : {
"type" : "integer"
}
}
}
queryOperator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EQ", "GT", "GE", "LT", "LE", "NE", "LIKE", "IN" ]
}
regressionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "LINEAR", "POLYNOMIAL", "LOESS" ]
}
reportingRate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"metric" : {
"$ref" : "reportingRateMetric.json"
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
reportingRateMetric
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "REPORTING_RATE", "REPORTING_RATE_ON_TIME", "ACTUAL_REPORTS", "ACTUAL_REPORTS_ON_TIME", "EXPECTED_REPORTS" ]
}
setMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : { }
}
}
softDeletableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
sortProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORT_NAME" ]
}
textAlign
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LEFT", "CENTER", "RIGHT" ]
}
totalAggregationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUM", "AVERAGE" ]
}
translatableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
}
}
}
valueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "LONG_TEXT", "LETTER", "PHONE_NUMBER", "EMAIL", "BOOLEAN", "TRUE_ONLY", "DATE", "DATETIME", "TIME", "NUMBER", "UNIT_INTERVAL", "PERCENTAGE", "INTEGER", "INTEGER_POSITIVE", "INTEGER_NEGATIVE", "INTEGER_ZERO_OR_POSITIVE", "TRACKER_ASSOCIATE", "USERNAME", "COORDINATE", "ORGANISATION_UNIT", "AGE", "URL", "FILE_RESOURCE", "IMAGE" ]
}
valueTypeOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"$ref" : "fileTypeValueOptions.json"
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
}
localPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
cacheStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NO_CACHE", "CACHE_1_MINUTE", "CACHE_5_MINUTES", "CACHE_10_MINUTES", "CACHE_15_MINUTES", "CACHE_30_MINUTES", "CACHE_1_HOUR", "CACHE_6AM_TOMORROW", "CACHE_TWO_WEEKS", "RESPECT_SYSTEM_SETTING" ]
}
cacheability
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PUBLIC", "PRIVATE" ]
}
appendingHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
cachingMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
mimicingHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
jsonPatch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"operations" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "addOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "add"
}
},
"required" : [ "op" ]
}, {
"$ref" : "removeOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "remove"
}
},
"required" : [ "op" ]
}, {
"$ref" : "replaceOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "replace"
}
},
"required" : [ "op" ]
} ]
}
}
}
}
weekday
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
}
configuration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"corsWhitelist" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"facilityOrgUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"facilityOrgUnitLevel" : {
"$ref" : "organisationUnitLevel.json"
},
"feedbackRecipients" : {
"$ref" : "userGroup.json"
},
"infrastructuralDataElements" : {
"$ref" : "dataElementGroup.json"
},
"infrastructuralIndicators" : {
"$ref" : "indicatorGroup.json"
},
"infrastructuralPeriodType" : {
"$ref" : "periodType.json"
},
"offlineOrganisationUnitLevel" : {
"$ref" : "organisationUnitLevel.json"
},
"selfRegistrationOrgUnit" : {
"$ref" : "organisationUnit.json"
},
"selfRegistrationRole" : {
"$ref" : "userAuthorityGroup.json"
},
"systemId" : {
"type" : "string"
}
}
}
constant
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "number"
}
}
}
dashboard
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowedFilters" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboardItems" : {
"type" : "array",
"items" : {
"$ref" : "dashboardItem.json"
}
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"itemConfig" : {
"$ref" : "itemConfig.json"
},
"itemCount" : {
"type" : "integer"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layout" : {
"$ref" : "layout.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"restrictFilters" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dashboardItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"appKey" : {
"type" : "string"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentCount" : {
"type" : "integer"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"eventChart" : {
"$ref" : "eventChart.json"
},
"eventReport" : {
"$ref" : "eventReport.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"height" : {
"type" : "integer"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretationCount" : {
"type" : "integer"
},
"interpretationLikeCount" : {
"type" : "integer"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"map" : {
"$ref" : "map.json"
},
"messages" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"shape" : {
"$ref" : "dashboardItemShape.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "dashboardItemType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
},
"width" : {
"type" : "integer"
},
"x" : {
"type" : "integer"
},
"y" : {
"type" : "integer"
}
}
}
dashboardItemShape
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NORMAL", "DOUBLE_WIDTH", "FULL_WIDTH" ]
}
dashboardItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION", "EVENT_CHART", "MAP", "EVENT_REPORT", "USERS", "REPORTS", "RESOURCES", "TEXT", "MESSAGES", "APP" ]
}
dashboardSearchResult
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"appCount" : {
"type" : "integer"
},
"apps" : {
"type" : "array",
"items" : {
"$ref" : "app.json"
}
},
"eventChartCount" : {
"type" : "integer"
},
"eventCharts" : {
"type" : "array",
"items" : {
"$ref" : "eventChart.json"
}
},
"eventReportCount" : {
"type" : "integer"
},
"eventReports" : {
"type" : "array",
"items" : {
"$ref" : "eventReport.json"
}
},
"mapCount" : {
"type" : "integer"
},
"maps" : {
"type" : "array",
"items" : {
"$ref" : "map.json"
}
},
"reportCount" : {
"type" : "integer"
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"resourceCount" : {
"type" : "integer"
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"searchCount" : {
"type" : "integer"
},
"userCount" : {
"type" : "integer"
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"visualizationCount" : {
"type" : "integer"
},
"visualizations" : {
"type" : "array",
"items" : {
"$ref" : "simpleVisualizationView.json"
}
}
}
}
column
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"index" : {
"type" : "integer"
},
"span" : {
"type" : "integer"
}
}
}
itemConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"insertHeight" : {
"type" : "integer"
},
"insertPosition" : {
"$ref" : "position.json"
}
}
}
layout
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "column.json"
}
},
"spacing" : {
"$ref" : "spacing.json"
}
}
}
position
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "START", "END" ]
}
spacing
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"row" : {
"type" : "integer"
}
}
}
dataAnalysisParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string"
},
"ou" : {
"type" : "string"
},
"standardDeviation" : {
"type" : "number"
},
"startDate" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"coc" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"de" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"ou" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startDate" : {
"type" : "string",
"format" : "date-time"
}
}
}
followupAnalysisResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followupValues" : {
"type" : "array",
"items" : {
"$ref" : "followupValue.json"
}
},
"metadata" : {
"$ref" : "followupAnalysisMetadata.json"
}
}
}
followupParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboId" : {
"type" : "integer"
},
"dataElementId" : {
"type" : "integer"
},
"followup" : {
"type" : "boolean"
},
"organisationUnitId" : {
"type" : "integer"
},
"periodId" : {
"type" : "integer"
}
}
}
followupValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"aoc" : {
"type" : "string"
},
"aocName" : {
"type" : "string"
},
"coc" : {
"type" : "string"
},
"cocName" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"de" : {
"type" : "string"
},
"deName" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"ou" : {
"type" : "string"
},
"ouName" : {
"type" : "string"
},
"ouPath" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"peEndDate" : {
"type" : "string",
"format" : "date-time"
},
"peName" : {
"type" : "string"
},
"peStartDate" : {
"type" : "string",
"format" : "date-time"
},
"peType" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
updateFollowUpForDataValuesRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followups" : {
"type" : "array",
"items" : {
"$ref" : "followupParams.json"
}
}
}
}
validationRuleExpressionDetails
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"leftSide" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"rightSide" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
validationRulesAnalysisParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"endDate" : {
"type" : "string"
},
"notification" : {
"type" : "boolean"
},
"ou" : {
"type" : "string"
},
"persist" : {
"type" : "boolean"
},
"startDate" : {
"type" : "string"
},
"vrg" : {
"type" : "string"
}
}
}
dataApproval
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalLevel" : {
"$ref" : "dataApprovalLevel.json"
}
}
}
dataApprovalAction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APPROVE", "UNAPPROVE", "ACCEPT", "UNACCEPT" ]
}
dataApprovalAndPermissions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalLevel" : {
"$ref" : "dataApprovalLevel.json"
}
}
}
dataApprovalAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"action" : {
"$ref" : "dataApprovalAction.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"creator" : {
"$ref" : "user.json"
},
"level" : {
"$ref" : "dataApprovalLevel.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"workflow" : {
"$ref" : "dataApprovalWorkflow.json"
}
}
}
dataApprovalLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionGroupSet" : {
"$ref" : "categoryOptionGroupSet.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"level" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"orgUnitLevel" : {
"type" : "integer"
},
"orgUnitLevelName" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataApprovalPermissions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"approvedAt" : {
"type" : "string",
"format" : "date-time"
},
"approvedBy" : {
"type" : "string"
},
"mayAccept" : {
"type" : "boolean"
},
"mayApprove" : {
"type" : "boolean"
},
"mayReadData" : {
"type" : "boolean"
},
"mayUnaccept" : {
"type" : "boolean"
},
"mayUnapprove" : {
"type" : "boolean"
},
"state" : {
"type" : "string"
}
}
}
dataApprovalState
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UNAPPROVABLE", "UNAPPROVED_ABOVE", "UNAPPROVED_WAITING", "UNAPPROVED_READY", "APPROVED_ABOVE", "APPROVED_HERE", "ACCEPTED_HERE" ]
}
dataApprovalStateRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ab" : {
"type" : "string"
},
"ad" : {
"type" : "string",
"format" : "date-time"
},
"ds" : {
"type" : "string"
},
"ou" : {
"type" : "string"
},
"pe" : {
"type" : "string"
}
}
}
dataApprovalStateResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"createdByUsername" : {
"type" : "string"
},
"createdDate" : {
"type" : "string",
"format" : "date-time"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"permissions" : {
"$ref" : "dataApprovalPermissions.json"
},
"state" : {
"type" : "string"
}
}
}
dataApprovalStateResponses
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalStateResponses" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalStateResponse.json"
}
}
}
}
dataApprovalWorkflow
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataApprovalLevels" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalLevel.json"
}
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
completeDataSetRegistrationRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"cc" : {
"type" : "string"
},
"cd" : {
"type" : "string",
"format" : "date-time"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"ds" : {
"type" : "string"
},
"multiOu" : {
"type" : "boolean"
},
"ou" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"sb" : {
"type" : "string"
}
}
}
dataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"commentOptionSet" : {
"$ref" : "optionSet.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"dataSetElements" : {
"type" : "array",
"items" : {
"$ref" : "dataSetElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"domainType" : {
"$ref" : "dataElementDomain.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldMask" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetValue" : {
"type" : "boolean"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
},
"valueTypeOptions" : {
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"$ref" : "fileTypeValueOptions.json"
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
},
"zeroIsSignificant" : {
"type" : "boolean"
}
}
}
dataElementDomain
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE", "TRACKER" ]
}
dataElementGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataElementGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataElementGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElementGroupSet" : {
"$ref" : "dataElementGroupSet.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
}
}
}
dataElementOperand
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
totalType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COC_ONLY", "AOC_ONLY", "COC_AND_AOC", "NONE" ]
}
dataEntryForm
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"format" : {
"type" : "integer"
},
"href" : {
"type" : "string"
},
"htmlCode" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"style" : {
"$ref" : "displayDensity.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
flattenedDataIntegrityReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElementsAssignedToDataSetsWithDifferentPeriodTypes" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsInDataSetNotInForm" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsWithoutDataSet" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dataElementsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dataSetsNotAssignedToOrganisationUnits" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"duplicatePeriods" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"indicatorsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"indicatorsWithIdenticalFormulas" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"indicatorsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"invalidCategoryCombos" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"invalidIndicatorDenominators" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidIndicatorNumerators" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidProgramIndicatorExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidProgramIndicatorFilters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidValidationRuleLeftSideExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidValidationRuleRightSideExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"organisationUnitGroupsWithoutGroupSets" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnitsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"organisationUnitsWithCyclicReferences" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnitsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"orphanedOrganisationUnits" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"programIndicatorsWithNoExpression" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"programRuleActionsWithNoDataObject" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoNotification" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoSectionId" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoStageId" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleVariablesWithNoAttribute" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleVariablesWithNoDataElement" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoAction" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoCondition" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoPriority" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"validationRulesWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
dataItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"programId" : {
"type" : "string"
},
"shortName" : {
"type" : "string"
},
"simplifiedValueType" : {
"$ref" : "valueType.json"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
dataItemBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code(String)" : {
"$ref" : "#"
},
"dimensionItemType(DimensionItemType)" : {
"$ref" : "#"
},
"displayName(String)" : {
"$ref" : "#"
},
"displayShortName(String)" : {
"$ref" : "#"
},
"id(String)" : {
"$ref" : "#"
},
"name(String)" : {
"$ref" : "#"
},
"programId(String)" : {
"$ref" : "#"
},
"shortName(String)" : {
"$ref" : "#"
},
"simplifiedValueType(ValueType)" : {
"$ref" : "#"
},
"valueType(ValueType)" : {
"$ref" : "#"
}
}
}
queryableDataItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR", "DATA_ELEMENT", "DATA_SET", "PROGRAM_INDICATOR", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE" ]
}
completeDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"completed" : {
"type" : "boolean"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"date" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"storedBy" : {
"type" : "string"
}
}
}
completeDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"closingDate" : {
"type" : "string",
"format" : "date-time"
},
"openingDate" : {
"type" : "string",
"format" : "date-time"
},
"period" : {
"$ref" : "period.json"
}
}
}
dataSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"compulsoryDataElementOperands" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"compulsoryFieldsCompleteOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementDecoration" : {
"type" : "boolean"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"dataInputPeriods" : {
"type" : "array",
"items" : {
"$ref" : "dataInputPeriod.json"
}
},
"dataSetElements" : {
"type" : "array",
"items" : {
"$ref" : "dataSetElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"expiryDays" : {
"type" : "integer"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldCombinationRequired" : {
"type" : "boolean"
},
"formName" : {
"type" : "string"
},
"formType" : {
"$ref" : "formType.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"mobile" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"noValueRequiresComment" : {
"type" : "boolean"
},
"notificationRecipients" : {
"$ref" : "userGroup.json"
},
"notifyCompletingUser" : {
"type" : "boolean"
},
"openFuturePeriods" : {
"type" : "integer"
},
"openPeriodsAfterCoEndDate" : {
"type" : "integer"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"renderAsTabs" : {
"type" : "boolean"
},
"renderHorizontally" : {
"type" : "boolean"
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "section.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipOffline" : {
"type" : "boolean"
},
"style" : {
"$ref" : "objectStyle.json"
},
"timelyDays" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validCompleteOnly" : {
"type" : "boolean"
},
"version" : {
"type" : "integer"
},
"workflow" : {
"$ref" : "dataApprovalWorkflow.json"
}
}
}
dataSetElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DEFAULT", "CUSTOM", "SECTION", "SECTION_MULTIORG" ]
}
lockException
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSet" : {
"$ref" : "dataSet.json"
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
}
}
}
section
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"description" : {
"type" : "string"
},
"disableDataElementAutoGroup" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"greyedFields" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"showColumnTotals" : {
"type" : "boolean"
},
"showRowTotals" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataSetNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_CONTACT", "USER_GROUP" ]
}
dataSetNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_CONTACT", "USER_GROUP" ]
}
dataSetNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSetNotificationTrigger" : {
"$ref" : "dataSetNotificationTrigger.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "dataSetNotificationRecipient.json"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroup" : {
"$ref" : "userGroup.json"
},
"relativeScheduledDays" : {
"type" : "integer"
},
"sendStrategy" : {
"$ref" : "sendStrategy.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataSetNotificationTemplateVariables
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NAME", "DATASET_DESCRIPTION", "COMPLETE_REG_OU", "COMPLETE_REG_PERIOD", "COMPLETE_REG_USER", "COMPLETE_REG_TIME", "COMPLETE_REG_ATT_OPT_COMBO", "CURRENT_DATE" ]
}
dataSetNotificationTemplateVariables
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NAME", "DATASET_DESCRIPTION", "COMPLETE_REG_OU", "COMPLETE_REG_PERIOD", "COMPLETE_REG_USER", "COMPLETE_REG_TIME", "COMPLETE_REG_ATT_OPT_COMBO", "CURRENT_DATE" ]
}
dataSetNotificationTrigger
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_SET_COMPLETION", "SCHEDULED_DAYS" ]
}
dbPoolTypes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "C3P0", "HIKARI" ]
}
aggregatedStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activeUsers" : {
"type" : "integer"
},
"averageDashboardViews" : {
"type" : "integer"
},
"averageEventChartViews" : {
"type" : "integer"
},
"averageEventReportViews" : {
"type" : "integer"
},
"averageMapViews" : {
"type" : "integer"
},
"averagePassiveDashboardViews" : {
"type" : "integer"
},
"averageViews" : {
"type" : "integer"
},
"averageVisualizationViews" : {
"type" : "integer"
},
"dashboardViews" : {
"type" : "integer"
},
"dataSetReportViews" : {
"type" : "integer"
},
"day" : {
"type" : "integer"
},
"eventChartViews" : {
"type" : "integer"
},
"eventReportViews" : {
"type" : "integer"
},
"mapViews" : {
"type" : "integer"
},
"month" : {
"type" : "integer"
},
"passiveDashboardViews" : {
"type" : "integer"
},
"savedDashboards" : {
"type" : "integer"
},
"savedDataValues" : {
"type" : "integer"
},
"savedEventCharts" : {
"type" : "integer"
},
"savedEventReports" : {
"type" : "integer"
},
"savedIndicators" : {
"type" : "integer"
},
"savedMaps" : {
"type" : "integer"
},
"savedVisualizations" : {
"type" : "integer"
},
"totalViews" : {
"type" : "integer"
},
"users" : {
"type" : "integer"
},
"visualizationViews" : {
"type" : "integer"
},
"week" : {
"type" : "integer"
},
"year" : {
"type" : "integer"
}
}
}
dataStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"activeUsers" : {
"type" : "integer"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboardViews" : {
"type" : "number"
},
"dataSetReportViews" : {
"type" : "number"
},
"displayName" : {
"type" : "string"
},
"eventChartViews" : {
"type" : "number"
},
"eventReportViews" : {
"type" : "number"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mapViews" : {
"type" : "number"
},
"name" : {
"type" : "string"
},
"passiveDashboardViews" : {
"type" : "number"
},
"publicAccess" : {
"type" : "string"
},
"savedDashboards" : {
"type" : "number"
},
"savedDataValues" : {
"type" : "number"
},
"savedEventCharts" : {
"type" : "number"
},
"savedEventReports" : {
"type" : "number"
},
"savedIndicators" : {
"type" : "number"
},
"savedMaps" : {
"type" : "number"
},
"savedVisualizations" : {
"type" : "number"
},
"sharing" : {
"$ref" : "sharing.json"
},
"totalViews" : {
"type" : "number"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "integer"
},
"visualizationViews" : {
"type" : "number"
}
}
}
dataStatisticsEventType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION_VIEW", "MAP_VIEW", "EVENT_REPORT_VIEW", "EVENT_CHART_VIEW", "DASHBOARD_VIEW", "PASSIVE_DASHBOARD_VIEW", "DATA_SET_REPORT_VIEW", "TOTAL_VIEW" ]
}
eventInterval
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAY", "WEEK", "MONTH", "YEAR" ]
}
favoriteStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"position" : {
"type" : "integer"
},
"views" : {
"type" : "integer"
}
}
}
dataSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activeUsers" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"dataValueCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"eventCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"objectCounts" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"userInvitations" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
}
}
}
dataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"period" : {
"$ref" : "period.json"
},
"source" : {
"$ref" : "organisationUnit.json"
},
"value" : {
"type" : "string"
}
}
}
dataValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"auditType" : {
"$ref" : "auditType_.json"
},
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"modifiedBy" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"value" : {
"type" : "string"
}
}
}
deflatedDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboName" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"dataElementId" : {
"type" : "integer"
},
"dataElementName" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"period" : {
"$ref" : "period.json"
},
"periodId" : {
"type" : "integer"
},
"sourceId" : {
"type" : "integer"
},
"sourceName" : {
"type" : "string"
},
"sourcePath" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
deduplicationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "OPEN", "INVALID", "MERGED" ]
}
mergeObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relationships" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
mergeObjectBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments(List<String>)" : {
"$ref" : "#"
},
"relationships(List<String>)" : {
"$ref" : "#"
},
"trackedEntityAttributes(List<String>)" : {
"$ref" : "#"
}
}
}
mergeStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MANUAL", "AUTO" ]
}
potentialDuplicate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"duplicate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserName" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"original" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "deduplicationStatus.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
deletedObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"deletedAt" : {
"type" : "string",
"format" : "date-time"
},
"deletedBy" : {
"type" : "string"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
document
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attachment" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentType" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"external" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
duration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "P1D", "P7D", "P14D", "P1M", "P2M", "P3M", "P6M", "P1Y" ]
}
importOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"async" : {
"type" : "boolean"
},
"datasetAllowsPeriods" : {
"type" : "boolean"
},
"dryRun" : {
"type" : "boolean"
},
"filename" : {
"type" : "string"
},
"firstRowIsHeader" : {
"type" : "boolean"
},
"force" : {
"type" : "boolean"
},
"idSchemes" : {
"$ref" : "idSchemes.json"
},
"ignoreEmptyCollection" : {
"type" : "boolean"
},
"importStrategy" : {
"$ref" : "importStrategy.json"
},
"mergeDataValues" : {
"type" : "boolean"
},
"mergeMode" : {
"$ref" : "mergeMode.json"
},
"notificationLevel" : {
"$ref" : "notificationLevel.json"
},
"preheatCache" : {
"type" : "boolean"
},
"reportMode" : {
"$ref" : "importReportMode.json"
},
"requireAttributeOptionCombo" : {
"type" : "boolean"
},
"requireCategoryOptionCombo" : {
"type" : "boolean"
},
"sharing" : {
"type" : "boolean"
},
"skipAudit" : {
"type" : "boolean"
},
"skipCache" : {
"type" : "boolean"
},
"skipExistingCheck" : {
"type" : "boolean"
},
"skipLastUpdated" : {
"type" : "boolean"
},
"skipNotifications" : {
"type" : "boolean"
},
"skipPatternValidation" : {
"type" : "boolean"
},
"strictAttributeOptionCombos" : {
"type" : "boolean"
},
"strictCategoryOptionCombos" : {
"type" : "boolean"
},
"strictDataElements" : {
"type" : "boolean"
},
"strictOrganisationUnits" : {
"type" : "boolean"
},
"strictPeriods" : {
"type" : "boolean"
}
}
}
importSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importCount" : {
"$ref" : "importCount.json"
},
"importTypeSummaries" : {
"type" : "array",
"items" : {
"$ref" : "importTypeSummary.json"
}
}
}
}
importTypeSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"conflicts" : {
"type" : "object"
},
"dataSetComplete" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enrollments" : {
"$ref" : "importSummaries.json"
},
"events" : {
"$ref" : "importSummaries.json"
},
"href" : {
"type" : "string"
},
"importConflicts" : {
"type" : "array",
"items" : {
"$ref" : "importConflict.json"
}
},
"importCount" : {
"$ref" : "importCount.json"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"lastImported" : {
"type" : "string"
},
"reference" : {
"type" : "string"
},
"relationships" : {
"$ref" : "importSummaries.json"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
},
"type" : {
"type" : "string"
}
}
}
csvImportClass
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_GROUP_MEMBERSHIP", "DATA_ELEMENT_GROUP_MEMBERSHIP", "INDICATOR_GROUP_MEMBERSHIP", "DATA_ELEMENT", "DATA_ELEMENT_GROUP", "CATEGORY_OPTION", "CATEGORY", "CATEGORY_COMBO", "CATEGORY_OPTION_GROUP", "ORGANISATION_UNIT", "ORGANISATION_UNIT_GROUP", "VALIDATION_RULE", "OPTION_SET", "OPTION_GROUP", "OPTION_GROUP_SET", "OPTION_GROUP_SET_MEMBERSHIP" ]
}
completeDataSetRegistration_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
completeDataSetRegistrations_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingJsonCompleteDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
streamingJsonCompleteDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingXmlCompleteDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
streamingXmlCompleteDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
dataValue_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingCsvDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingJsonDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingXmlDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
dataValueImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT_NOT_FOUND", "PERIOD_NOT_VALID", "ORG_UNIT_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_ACCESSIBLE", "ATTR_OPTION_COMBO_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_ACCESSIBLE", "ORG_UNIT_NOT_IN_USER_HIERARCHY", "DATA_ELEMENT_VALUE_NOT_DEFINED", "DATA_ELEMENT_VALUE_NOT_VALID", "COMMENT_NOT_VALID", "DATA_ELEMENT_INVALID_OPTION", "CATEGORY_OPTION_COMBO_NOT_SPECIFIED", "ATTR_OPTION_COMBO_NOT_SPECIFIED", "PERIOD_TYPE_NOT_VALID_FOR_DATA_ELEMENT", "DATA_ELEMENT_STRICT", "CATEGORY_OPTION_COMBO_STRICT", "ATTR_OPTION_COMBO_STRICT", "ORG_UNIT_STRICT", "STORED_BY_NOT_VALID", "PERIOD_NOT_VALID_FOR_ATTR_OPTION_COMBO", "ORG_UNIT_NOT_VALID_FOR_ATTR_OPTION_COMBO", "PERIOD_EXPIRED", "PERIOD_AFTER_DATA_ELEMENT_PERIODS", "VALUE_ALREADY_APPROVED", "PERIOD_NOT_OPEN_FOR_DATA_SET", "PERIOD_NOT_CONFORM_TO_OPEN_PERIODS", "FILE_RESOURCE_NOT_FOUND" ]
}
dataValueImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT_NOT_FOUND", "PERIOD_NOT_VALID", "ORG_UNIT_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_ACCESSIBLE", "ATTR_OPTION_COMBO_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_ACCESSIBLE", "ORG_UNIT_NOT_IN_USER_HIERARCHY", "DATA_ELEMENT_VALUE_NOT_DEFINED", "DATA_ELEMENT_VALUE_NOT_VALID", "COMMENT_NOT_VALID", "DATA_ELEMENT_INVALID_OPTION", "CATEGORY_OPTION_COMBO_NOT_SPECIFIED", "ATTR_OPTION_COMBO_NOT_SPECIFIED", "PERIOD_TYPE_NOT_VALID_FOR_DATA_ELEMENT", "DATA_ELEMENT_STRICT", "CATEGORY_OPTION_COMBO_STRICT", "ATTR_OPTION_COMBO_STRICT", "ORG_UNIT_STRICT", "STORED_BY_NOT_VALID", "PERIOD_NOT_VALID_FOR_ATTR_OPTION_COMBO", "ORG_UNIT_NOT_VALID_FOR_ATTR_OPTION_COMBO", "PERIOD_EXPIRED", "PERIOD_AFTER_DATA_ELEMENT_PERIODS", "VALUE_ALREADY_APPROVED", "PERIOD_NOT_OPEN_FOR_DATA_SET", "PERIOD_NOT_CONFORM_TO_OPEN_PERIODS", "FILE_RESOURCE_NOT_FOUND" ]
}
dataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
dataValueSetImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NOT_FOUND", "DATASET_NOT_ACCESSIBLE", "DATASET_NOT_VALID", "ORG_UNIT_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_FOUND" ]
}
dataValueSetImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NOT_FOUND", "DATASET_NOT_ACCESSIBLE", "DATASET_NOT_VALID", "ORG_UNIT_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_FOUND" ]
}
streamingCsvDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingJsonDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingXmlDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
relationshipParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"includeFrom" : {
"type" : "boolean"
},
"includeTo" : {
"type" : "boolean"
}
}
}
trackedEntityInstanceParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSynchronizationQuery" : {
"type" : "boolean"
},
"includeDeleted" : {
"type" : "boolean"
},
"includeEnrollments" : {
"type" : "boolean"
},
"includeEvents" : {
"type" : "boolean"
},
"includeProgramOwners" : {
"type" : "boolean"
},
"includeRelationships" : {
"type" : "boolean"
}
}
}
enrollment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string",
"format" : "date-time"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"enrollment" : {
"type" : "string"
},
"enrollmentDate" : {
"type" : "string",
"format" : "date-time"
},
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"incidentDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"status" : {
"$ref" : "enrollmentStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityType" : {
"type" : "string"
}
},
"required" : [ "created", "createdAtClient", "enrollment", "enrollmentDate", "incidentDate", "lastUpdated", "lastUpdatedAtClient", "program", "status", "trackedEntityInstance", "trackedEntityType" ]
}
enrollmentStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
enrollments
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments" : {
"type" : "array",
"items" : {
"$ref" : "enrollment.json"
}
}
}
}
dataValue__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"dataElement" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
event
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUser" : {
"type" : "string"
},
"assignedUserDisplayName" : {
"type" : "string"
},
"assignedUserUsername" : {
"type" : "string"
},
"attributeCategoryOptions" : {
"type" : "string"
},
"attributeOptionCombo" : {
"type" : "string"
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue__.json"
}
},
"deleted" : {
"type" : "boolean"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"enrollmentStatus" : {
"$ref" : "enrollmentStatus.json"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"programType" : {
"$ref" : "programType.json"
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"status" : {
"$ref" : "eventStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
}
},
"required" : [ "createdAtClient", "enrollment", "enrollmentStatus", "event", "eventDate", "lastUpdatedAtClient", "program", "programStage", "programType", "status" ]
}
events
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"metaData" : {
"type" : "object"
},
"pager" : {
"$ref" : "pager.json"
},
"program" : {
"type" : "string"
},
"programInstance" : {
"type" : "string"
}
}
}
note
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "userInfoSnapshot.json"
},
"note" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"storedDate" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
csvEventDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"geometry" : {
"type" : "string"
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"orgUnit" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"providedElsewhere" : {
"type" : "boolean"
},
"status" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
eventRow
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "string"
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue__.json"
}
},
"deleted" : {
"type" : "boolean"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityInstanceCreated" : {
"type" : "string"
},
"trackedEntityInstanceInactive" : {
"type" : "boolean"
},
"trackedEntityInstanceOrgUnit" : {
"type" : "string"
},
"trackedEntityInstanceOrgUnitName" : {
"type" : "string"
}
},
"required" : [ "eventDate" ]
}
eventRows
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"eventRows" : {
"type" : "array",
"items" : {
"$ref" : "eventRow.json"
}
},
"pager" : {
"$ref" : "pager.json"
}
}
}
attribute_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ownerOrgUnit" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
}
}
}
relationship
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"bidirectional" : {
"type" : "boolean"
},
"created" : {
"type" : "string"
},
"from" : {
"$ref" : "relationshipItem.json"
},
"lastUpdated" : {
"type" : "string"
},
"relationship" : {
"type" : "string"
},
"relationshipName" : {
"type" : "string"
},
"relationshipType" : {
"type" : "string"
},
"to" : {
"$ref" : "relationshipItem.json"
}
}
}
relationshipItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollment" : {
"$ref" : "enrollment.json"
},
"event" : {
"$ref" : "event.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance.json"
}
}
}
relationships
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
}
}
}
trackedEntityInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"coordinates" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"enrollments" : {
"type" : "array",
"items" : {
"$ref" : "enrollment.json"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"geometry" : {
"$ref" : "geometry.json"
},
"inactive" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"orgUnit" : {
"type" : "string"
},
"potentialDuplicate" : {
"type" : "boolean"
},
"programOwners" : {
"type" : "array",
"items" : {
"$ref" : "programOwner.json"
}
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityType" : {
"type" : "string"
}
},
"required" : [ "created", "createdAtClient", "lastUpdated", "lastUpdatedAtClient", "orgUnit", "trackedEntityInstance", "trackedEntityType" ]
}
trackedEntityInstances
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"trackedEntityInstances" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityInstance.json"
}
}
}
}
cOLUMNS
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEI_UID", "ID", "UID", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "STATUS", "GEOMETRY", "ENROLLMENTDATE", "INCIDENTDATE", "FOLLOWUP", "COMPLETED", "COMPLETEDBY", "STOREDBY", "DELETED", "PROGRAM_UID", "PROGRAM_FEATURE_TYPE", "TEI_TYPE_UID", "ORGUNIT_UID", "ORGUNIT_NAME" ]
}
cOLUMNS_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "UID", "STATUS", "EXECUTION_DATE", "DUE_DATE", "STOREDBY", "COMPLETEDBY", "COMPLETEDDATE", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "DELETED", "GEOMETRY", "TEI_UID", "ENROLLMENT_UID", "ENROLLMENT_FOLLOWUP", "ENROLLMENT_STATUS", "PROGRAM_UID", "PROGRAM_STAGE_UID", "ORGUNIT_UID", "ORGUNIT_NAME", "COC_UID", "CAT_OPTIONS" ]
}
cOLUMNS__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEI_UID", "TEI_ID", "CREATED", "UPDATED", "VALUE", "STOREDBY", "ATTR_UID", "ATTR_NAME", "ATTR_VALUE_TYPE", "ATTR_CODE", "ATTR_SKIP_SYNC" ]
}
cOLUMNS___
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UID", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "INACTIVE", "DELETED", "GEOMETRY", "TYPE_UID", "ORGUNIT_UID", "TRACKEDENTITYINSTANCEID" ]
}
importConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"object" : {
"type" : "string"
},
"objects" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"property" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
importCount
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"imported" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
importStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "WARNING", "ERROR" ]
}
importSummaries
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"importSummaries" : {
"type" : "array",
"items" : {
"$ref" : "importSummary_.json"
}
},
"imported" : {
"type" : "integer"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
},
"total" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
importSummary_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"conflicts" : {
"type" : "object"
},
"dataSetComplete" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enrollments" : {
"$ref" : "importSummaries.json"
},
"events" : {
"$ref" : "importSummaries.json"
},
"href" : {
"type" : "string"
},
"importCount" : {
"$ref" : "importCount.json"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"reference" : {
"type" : "string"
},
"relationships" : {
"$ref" : "importSummaries.json"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
}
}
}
atomicMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "NONE" ]
}
flushMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OBJECT", "AUTO" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"analyticsTableHooks" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableHook.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"categoryOptionGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"constants" : {
"type" : "array",
"items" : {
"$ref" : "constant.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dashboardItems" : {
"type" : "array",
"items" : {
"$ref" : "dashboardItem.json"
}
},
"dashboards" : {
"type" : "array",
"items" : {
"$ref" : "dashboard.json"
}
},
"dataApprovalLevels" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalLevel.json"
}
},
"dataApprovalWorkflows" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalWorkflow.json"
}
},
"dataElementGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSet.json"
}
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"dataElementOperands" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"dataEntryForms" : {
"type" : "array",
"items" : {
"$ref" : "dataEntryForm.json"
}
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"dimensions" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"documents" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"eventCharts" : {
"type" : "array",
"items" : {
"$ref" : "eventChart.json"
}
},
"eventReports" : {
"type" : "array",
"items" : {
"$ref" : "eventReport.json"
}
},
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"externalMapLayers" : {
"type" : "array",
"items" : {
"$ref" : "externalMapLayer.json"
}
},
"indicatorGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroupSet.json"
}
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"indicatorTypes" : {
"type" : "array",
"items" : {
"$ref" : "indicatorType.json"
}
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "nameableObject.json"
}
},
"jobConfigurations" : {
"type" : "array",
"items" : {
"$ref" : "jobConfiguration.json"
}
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"mapViews" : {
"type" : "array",
"items" : {
"$ref" : "mapView.json"
}
},
"maps" : {
"type" : "array",
"items" : {
"$ref" : "map.json"
}
},
"metadataVersions" : {
"type" : "array",
"items" : {
"$ref" : "metadataVersion.json"
}
},
"optionGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "optionGroupSet.json"
}
},
"optionGroups" : {
"type" : "array",
"items" : {
"$ref" : "optionGroup.json"
}
},
"optionSets" : {
"type" : "array",
"items" : {
"$ref" : "optionSet.json"
}
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"organisationUnitGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSet.json"
}
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitLevel.json"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"predictorGroups" : {
"type" : "array",
"items" : {
"$ref" : "predictorGroup.json"
}
},
"predictors" : {
"type" : "array",
"items" : {
"$ref" : "predictor.json"
}
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programNotificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"programRuleActions" : {
"type" : "array",
"items" : {
"$ref" : "programRuleAction.json"
}
},
"programRuleVariables" : {
"type" : "array",
"items" : {
"$ref" : "programRuleVariable.json"
}
},
"programRules" : {
"type" : "array",
"items" : {
"$ref" : "programRule.json"
}
},
"programStageSections" : {
"type" : "array",
"items" : {
"$ref" : "programStageSection.json"
}
},
"programStages" : {
"type" : "array",
"items" : {
"$ref" : "programStage.json"
}
},
"programs" : {
"type" : "array",
"items" : {
"$ref" : "program.json"
}
},
"relationshipTypes" : {
"type" : "array",
"items" : {
"$ref" : "relationshipType.json"
}
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"schemas" : {
"type" : "array",
"items" : {
"$ref" : "schema.json"
}
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "section.json"
}
},
"sqlViews" : {
"type" : "array",
"items" : {
"$ref" : "sqlView.json"
}
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttribute.json"
}
},
"trackedEntityTypes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityType.json"
}
},
"userGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"validationNotificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "validationNotificationTemplate.json"
}
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"$ref" : "validationRuleGroup.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"atomicMode" : {
"$ref" : "atomicMode.json"
},
"csvImportClass" : {
"$ref" : "csvImportClass.json"
},
"filename" : {
"type" : "string"
},
"firstRowIsHeader" : {
"type" : "boolean"
},
"flushMode" : {
"$ref" : "flushMode.json"
},
"identifier" : {
"$ref" : "preheatIdentifier.json"
},
"importMode" : {
"$ref" : "objectBundleMode.json"
},
"importReportMode" : {
"$ref" : "importReportMode.json"
},
"importStrategy" : {
"$ref" : "importStrategy.json"
},
"mergeMode" : {
"$ref" : "mergeMode.json"
},
"metadataSyncImport" : {
"type" : "boolean"
},
"preheatMode" : {
"$ref" : "preheatMode.json"
},
"skipSharing" : {
"type" : "boolean"
},
"skipTranslation" : {
"type" : "boolean"
},
"skipValidation" : {
"type" : "boolean"
},
"userOverrideMode" : {
"$ref" : "userOverrideMode.json"
},
"username" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"metadata" : {
"type" : "string"
}
}
}
userOverrideMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "CURRENT", "SELECTED" ]
}
importReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importParams" : {
"$ref" : "metadataImportParams.json"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
},
"typeReports" : {
"type" : "array",
"items" : {
"$ref" : "typeReport.json"
}
}
}
}
importReportMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FULL", "ERRORS", "ERRORS_NOT_OWNER", "DEBUG" ]
}
objectBundleMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMMIT", "VALIDATE" ]
}
objectBundleStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATED", "VALIDATED", "COMMITTED" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importReport" : {
"$ref" : "importReport.json"
},
"importSummary" : {
"$ref" : "importSummary.json"
},
"metadataVersion" : {
"$ref" : "metadataVersion.json"
}
}
}
jobConfigurationWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"jobParameters" : {
"$ref" : "jobParameters.json"
},
"jobStatus" : {
"$ref" : "jobStatus.json"
},
"jobType" : {
"$ref" : "jobType.json"
},
"name" : {
"type" : "string"
},
"relativeNotifierEndpoint" : {
"type" : "string"
}
}
}
syncEndpoint
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCES", "ENROLLMENTS", "EVENTS", "COMPLETE_DATA_SET_REGISTRATIONS", "DATA_VALUE_SETS" ]
}
synchronizationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "FAILURE" ]
}
availabilityStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"available" : {
"type" : "boolean"
},
"message" : {
"type" : "string"
},
"statusCode" : {
"type" : "integer"
},
"statusPhrase" : {
"type" : "string"
}
}
}
abstractWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"responseType" : {
"type" : "string"
}
}
}
descriptiveWebMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "integer"
},
"description" : {
"type" : "string"
},
"devMessage" : {
"type" : "string"
},
"errorCode" : {
"$ref" : "errorCode.json"
},
"httpStatus" : {
"type" : "string"
},
"httpStatusCode" : {
"type" : "integer"
},
"message" : {
"type" : "string"
},
"response" : {
"$ref" : "webMessageResponse.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
webMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "integer"
},
"devMessage" : {
"type" : "string"
},
"errorCode" : {
"$ref" : "errorCode.json"
},
"httpStatus" : {
"type" : "string"
},
"httpStatusCode" : {
"type" : "integer"
},
"message" : {
"type" : "string"
},
"response" : {
"$ref" : "webMessageResponse.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
webMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
errorReportsWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"responseType" : {
"type" : "string"
}
}
}
fileResourceWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fileResource" : {
"$ref" : "fileResource.json"
},
"responseType" : {
"type" : "string"
}
}
}
importCountWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "integer"
},
"deleted" : {
"type" : "integer"
},
"responseType" : {
"type" : "string"
},
"updated" : {
"type" : "integer"
}
}
}
importReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"responseType" : {
"type" : "string"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
},
"typeReports" : {
"type" : "array",
"items" : {
"$ref" : "typeReport.json"
}
}
}
}
objectReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"klass" : {
"type" : "string"
},
"responseType" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
typeReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"objectReports" : {
"type" : "array",
"items" : {
"$ref" : "objectReport.json"
}
},
"responseType" : {
"type" : "string"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
email
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"sender" : {
"$ref" : "user.json"
},
"subject" : {
"type" : "string"
},
"text" : {
"type" : "string"
}
}
}
emailResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SENT", "FAILED", "ABORTED", "NOT_CONFIGURED", "HOST_CONFIG_NOT_FOUND" ]
}
encryptionStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "MISSING_JCE_POLICY", "MISSING_ENCRYPTION_PASSWORD", "ENCRYPTION_PASSWORD_TOO_SHORT" ]
}
eventStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "VISITED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
baseChart
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"baseLineLabel" : {
"type" : "string"
},
"baseLineValue" : {
"type" : "number"
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideLegend" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendDisplayStrategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer"
},
"rangeAxisLabel" : {
"type" : "string"
},
"rangeAxisMaxValue" : {
"type" : "number"
},
"rangeAxisMinValue" : {
"type" : "number"
},
"rangeAxisSteps" : {
"type" : "integer"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string"
},
"targetLineValue" : {
"type" : "number"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
eventChart
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValueDimension" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"baseLineLabel" : {
"type" : "string"
},
"baseLineValue" : {
"type" : "number"
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"collapseDataDimensions" : {
"type" : "boolean"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"dataElementValueDimension" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideLegend" : {
"type" : "boolean"
},
"hideNaData" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendDisplayStrategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outputType" : {
"$ref" : "eventOutputType.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer"
},
"rangeAxisLabel" : {
"type" : "string"
},
"rangeAxisMaxValue" : {
"type" : "number"
},
"rangeAxisMinValue" : {
"type" : "number"
},
"rangeAxisSteps" : {
"type" : "integer"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string"
},
"targetLineValue" : {
"type" : "number"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"value" : {
"$ref" : "dimensionalItemObject.json"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
eventDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
eventReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValueDimension" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"colSubTotals" : {
"type" : "boolean"
},
"colTotals" : {
"type" : "boolean"
},
"collapseDataDimensions" : {
"type" : "boolean"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"dataElementValueDimension" : {
"$ref" : "dataElement.json"
},
"dataType" : {
"$ref" : "eventDataType.json"
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDensity" : {
"$ref" : "displayDensity.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"fontSize" : {
"$ref" : "fontSize.json"
},
"formName" : {
"type" : "string"
},
"hideEmptyRows" : {
"type" : "boolean"
},
"hideNaData" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outputType" : {
"$ref" : "eventOutputType.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rowSubTotals" : {
"type" : "boolean"
},
"rowTotals" : {
"type" : "boolean"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showDimensionLabels" : {
"type" : "boolean"
},
"showHierarchy" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"value" : {
"$ref" : "dimensionalItemObject.json"
}
}
}
expression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"missingValueStrategy" : {
"$ref" : "missingValueStrategy.json"
},
"slidingWindow" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
}
}
}
expressionValidationOutcome
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VALID", "EXPRESSION_IS_EMPTY", "DIMENSIONAL_ITEM_OBJECT_DOES_NOT_EXIST", "CONSTANT_DOES_NOT_EXIST", "ORG_UNIT_GROUP_DOES_NOT_EXIST", "EXPRESSION_IS_NOT_WELL_FORMED" ]
}
missingValueStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SKIP_IF_ANY_VALUE_MISSING", "SKIP_IF_ALL_VALUES_MISSING", "NEVER_SKIP" ]
}
operator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "equal_to", "not_equal_to", "greater_than", "greater_than_or_equal_to", "less_than", "less_than_or_equal_to", "compulsory_pair", "exclusive_pair" ]
}
parseType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR_EXPRESSION", "VALIDATION_RULE_EXPRESSION", "PREDICTOR_EXPRESSION", "PREDICTOR_SKIP_TEST", "SIMPLE_TEST" ]
}
configurationKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SYSTEM_READ_ONLY_MODE", "SYSTEM_SESSION_TIMEOUT", "SYSTEM_MONITORING_URL", "SYSTEM_MONITORING_USERNAME", "SYSTEM_MONITORING_PASSWORD", "SYSTEM_SQL_VIEW_TABLE_PROTECTION", "SYSTEM_PROGRAM_RULE_SERVER_EXECUTION", "SYSTEM_CACHE_MAX_SIZE_FACTOR", "SYSTEM_CACHE_CAP_PERCENTAGE", "NODE_ID", "ENCRYPTION_PASSWORD", "CONNECTION_DIALECT", "CONNECTION_DRIVER_CLASS", "CONNECTION_URL", "CONNECTION_USERNAME", "CONNECTION_PASSWORD", "CONNECTION_SCHEMA", "CONNECTION_POOL_MAX_SIZE", "CONNECTION_POOL_MIN_SIZE", "CONNECTION_POOL_INITIAL_SIZE", "CONNECTION_POOL_ACQUIRE_INCR", "CONNECTION_POOL_MAX_IDLE_TIME", "CONNECTION_POOL_MAX_IDLE_TIME_EXCESS_CON", "CONNECTION_POOL_IDLE_CON_TEST_PERIOD", "CONNECTION_POOL_TEST_ON_CHECKOUT", "CONNECTION_POOL_TEST_ON_CHECKIN", "CONNECTION_POOL_TIMEOUT", "CONNECTION_POOL_VALIDATION_TIMEOUT", "CONNECTION_POOL_NUM_THREADS", "CONNECTION_POOL_TEST_QUERY", "LDAP_URL", "LDAP_MANAGER_DN", "LDAP_MANAGER_PASSWORD", "LDAP_SEARCH_BASE", "LDAP_SEARCH_FILTER", "FILESTORE_PROVIDER", "FILESTORE_CONTAINER", "FILESTORE_LOCATION", "FILESTORE_IDENTITY", "FILESTORE_SECRET", "GOOGLE_SERVICE_ACCOUNT_CLIENT_ID", "META_DATA_SYNC_RETRY", "META_DATA_SYNC_RETRY_TIME_FREQUENCY_MILLISEC", "CLUSTER_HOSTNAME", "CLUSTER_MEMBERS", "CLUSTER_CACHE_PORT", "CLUSTER_CACHE_REMOTE_OBJECT_PORT", "REDIS_HOST", "REDIS_PORT", "REDIS_PASSWORD", "REDIS_ENABLED", "REDIS_USE_SSL", "FLYWAY_OUT_OF_ORDER_MIGRATION", "FLYWAY_REPAIR_BEFORE_MIGRATION", "PROGRAM_TEMPORARY_OWNERSHIP_TIMEOUT", "LEADER_TIME_TO_LIVE", "ANALYTICS_CACHE_EXPIRATION", "ARTEMIS_MODE", "ARTEMIS_HOST", "ARTEMIS_PORT", "ARTEMIS_USERNAME", "ARTEMIS_PASSWORD", "ARTEMIS_EMBEDDED_SECURITY", "ARTEMIS_EMBEDDED_PERSISTENCE", "ARTEMIS_EMBEDDED_THREADS", "LOGGING_FILE_MAX_SIZE", "LOGGING_FILE_MAX_ARCHIVES", "LOGGING_REQUEST_ID_HASH", "LOGGING_REQUEST_ID_ENABLED", "LOGGING_REQUEST_ID_MAX_SIZE", "SERVER_BASE_URL", "SERVER_HTTPS", "MONITORING_PROVIDER", "MONITORING_API_ENABLED", "MONITORING_JVM_ENABLED", "MONITORING_DBPOOL_ENABLED", "MONITORING_HIBERNATE_ENABLED", "MONITORING_UPTIME_ENABLED", "MONITORING_CPU_ENABLED", "APPHUB_BASE_URL", "APPHUB_API_URL", "CHANGELOG_AGGREGATE", "CHANGELOG_TRACKER", "AUDIT_USE_INMEMORY_QUEUE_ENABLED", "AUDIT_USE_IN_MEMORY_QUEUE_ENABLED", "AUDIT_LOGGER", "AUDIT_DATABASE", "AUDIT_METADATA_MATRIX", "AUDIT_TRACKER_MATRIX", "AUDIT_AGGREGATE_MATRIX", "OIDC_OAUTH2_LOGIN_ENABLED", "OIDC_LOGOUT_REDIRECT_URL", "OIDC_PROVIDER_GOOGLE_CLIENT_ID", "OIDC_PROVIDER_GOOGLE_CLIENT_SECRET", "OIDC_PROVIDER_GOOGLE_MAPPING_CLAIM", "OIDC_PROVIDER_GOOGLE_REDIRECT_URI", "OIDC_PROVIDER_WSO2_CLIENT_ID", "OIDC_PROVIDER_WSO2_CLIENT_SECRET", "OIDC_PROVIDER_WSO2_MAPPING_CLAIM", "OIDC_PROVIDER_WSO2_SERVER_URL", "OIDC_PROVIDER_WSO2_REDIRECT_URI", "OIDC_PROVIDER_WSO2_DISPLAY_ALIAS", "OIDC_PROVIDER_WSO2_ENABLE_LOGOUT", "SLOW_QUERY_LOGGING_THRESHOLD_TIME_MS", "ENABLE_QUERY_LOGGING", "METHOD_QUERY_LOGGING_ENABLED", "ELAPSED_TIME_QUERY_LOGGING_ENABLED", "DB_POOL_TYPE", "ACTIVE_READ_REPLICAS", "AUDIT_ENABLED", "TRACKER_IMPORT_PREHEAT_CACHE_ENABLED", "ENABLE_OAUTH2_AUTHORIZATION_SERVER", "ENABLE_JWT_OIDC_TOKEN_AUTHENTICATION", "DEBEZIUM_ENABLED", "DEBEZIUM_CONNECTION_USERNAME", "DEBEZIUM_CONNECTION_PASSWORD", "DEBEZIUM_DB_HOSTNAME", "DEBEZIUM_DB_PORT", "DEBEZIUM_DB_NAME", "DEBEZIUM_SLOT_NAME", "DEBEZIUM_EXCLUDE_LIST", "DEBEZIUM_SHUTDOWN_ON_CONNECTOR_STOP", "ENABLE_API_TOKEN_AUTHENTICATION" ]
}
googleAccessToken
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access_token" : {
"type" : "string"
},
"client_id" : {
"type" : "string"
},
"expires_in" : {
"type" : "integer"
}
}
}
errorCode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "E1000", "E1001", "E1002", "E1100", "E1101", "E1102", "E1103", "E1104", "E1105", "E1106", "E1107", "E1500", "E1501", "E1502", "E1503", "E1504", "E1510", "E1511", "E1512", "E1513", "E1514", "E1515", "E1516", "E1520", "E1521", "E1522", "E1523", "E2000", "E2001", "E2002", "E2003", "E2004", "E2005", "E2006", "E2007", "E2008", "E2009", "E2010", "E2011", "E2012", "E2013", "E2014", "E2015", "E2016", "E2017", "E2018", "E2019", "E2020", "E2021", "E2022", "E2023", "E2024", "E2025", "E2026", "E2027", "E2028", "E2029", "E2030", "E2031", "E2032", "E2033", "E2034", "E2035", "E2036", "E2037", "E2038", "E2200", "E2201", "E2202", "E2203", "E2204", "E2205", "E2206", "E2207", "E2208", "E2300", "E2301", "E3000", "E3001", "E3002", "E3003", "E3004", "E3005", "E3006", "E3008", "E3009", "E3010", "E3011", "E3012", "E3013", "E3014", "E3015", "E3016", "E3017", "E3018", "E4000", "E4001", "E4002", "E4003", "E4004", "E4005", "E4006", "E4007", "E4008", "E4009", "E4010", "E4011", "E4012", "E4013", "E4014", "E4015", "E4016", "E4017", "E4018", "E4019", "E4020", "E4021", "E4022", "E4023", "E4024", "E4025", "E4026", "E4027", "E4028", "E4029", "E4030", "E4033", "E4034", "E4035", "E4036", "E4037", "E4038", "E4039", "E4040", "E4041", "E4042", "E4043", "E4044", "E4045", "E4046", "E4047", "E4048", "E4049", "E4050", "E4051", "E4052", "E4053", "E4300", "E4301", "E4302", "E4303", "E4304", "E4305", "E4306", "E4307", "E4308", "E4309", "E4310", "E4311", "E4312", "E4313", "E5000", "E5001", "E5002", "E5003", "E5004", "E5005", "E5006", "E6000", "E6001", "E6100", "E6101", "E6200", "E7000", "E7003", "E7004", "E7005", "E7006", "E7007", "E7010", "E7100", "E7101", "E7102", "E7103", "E7104", "E7105", "E7106", "E7107", "E7108", "E7109", "E7110", "E7111", "E7112", "E7113", "E7114", "E7115", "E7116", "E7117", "E7118", "E7119", "E7120", "E7121", "E7122", "E7123", "E7124", "E7125", "E7126", "E7127", "E7128", "E7129", "E7130", "E7131", "E7132", "E7133", "E7200", "E7201", "E7202", "E7203", "E7204", "E7205", "E7206", "E7207", "E7208", "E7209", "E7210", "E7211", "E7212", "E7213", "E7214", "E7215", "E7216", "E7217", "E7218", "E7219", "E7220", "E7221", "E7222", "E7223", "E7224", "E7225", "E7226", "E7227", "E7228", "E7229", "E7300", "E7301", "E7400", "E7500", "E7501", "E7502", "E7503", "E7600", "E7601", "E7602", "E7603", "E7604", "E7610", "E7611", "E7612", "E7613", "E7614", "E7615", "E7616", "E7617", "E7618", "E7619", "E7620", "E7621", "E7630", "E7631", "E7632", "E7633", "E7634", "E7635", "E7636", "E7637", "E7638", "E7639", "E7640", "E7641", "E7642", "E7643", "E7644", "E7645" ]
}
errorReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"errorKlass" : {
"type" : "string"
},
"errorProperties" : {
"type" : "array",
"items" : { }
},
"errorProperty" : {
"type" : "string"
},
"mainId" : {
"type" : "string"
},
"mainKlass" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"value" : { }
}
}
objectReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"displayName" : {
"type" : "string"
},
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"index" : {
"type" : "integer"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
stats
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "integer"
},
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"total" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
status
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "WARNING", "ERROR" ]
}
typeReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"klass" : {
"type" : "string"
},
"objectReports" : {
"type" : "array",
"items" : {
"$ref" : "objectReport.json"
}
},
"stats" : {
"$ref" : "stats.json"
}
}
}
defaults
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCLUDE", "EXCLUDE" ]
}
fieldMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
externalFileResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accessToken" : {
"type" : "string"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"expires" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fileResource" : {
"$ref" : "fileResource.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
fileResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentLength" : {
"type" : "integer"
},
"contentMd5" : {
"type" : "string"
},
"contentType" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"domain" : {
"$ref" : "fileResourceDomain.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hasMultipleStorageFiles" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"storageStatus" : {
"$ref" : "fileResourceStorageStatus.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
fileResourceDomain
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_VALUE", "PUSH_ANALYSIS", "DOCUMENT", "MESSAGE_ATTACHMENT", "USER_AVATAR", "ORG_UNIT" ]
}
fileResourceRetentionStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "THREE_MONTHS", "ONE_YEAR", "FOREVER" ]
}
fileResourceStorageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "PENDING", "FAILED", "STORED" ]
}
imageFileDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SMALL", "MEDIUM", "LARGE", "ORIGINAL" ]
}
simpleImageResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"images" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
gistAutoType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "XL", "L", "M", "S", "XS" ]
}
idObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"nextPage" : {
"type" : "string"
},
"page" : {
"type" : "integer"
},
"pageCount" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"prevPage" : {
"type" : "string"
},
"total" : {
"type" : "integer"
}
}
}
gistQuery
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absoluteUrls" : {
"type" : "boolean"
},
"anyFilter" : {
"type" : "boolean"
},
"auto" : {
"$ref" : "gistAutoType.json"
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "field.json"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "filter.json"
}
},
"headless" : {
"type" : "boolean"
},
"inverse" : {
"type" : "boolean"
},
"orders" : {
"type" : "array",
"items" : {
"$ref" : "order.json"
}
},
"pageOffset" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"total" : {
"type" : "boolean"
},
"translate" : {
"type" : "boolean"
}
}
}
comparison
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NULL", "NOT_NULL", "EQ", "IEQ", "NE", "LT", "LE", "GT", "GE", "IN", "NOT_IN", "EMPTY", "NOT_EMPTY", "LIKE", "NOT_LIKE", "STARTS_LIKE", "NOT_STARTS_LIKE", "ENDS_LIKE", "NOT_ENDS_LIKE", "ILIKE", "NOT_ILIKE", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "CAN_READ", "CAN_WRITE", "CAN_DATA_READ", "CAN_DATA_WRITE", "CAN_ACCESS" ]
}
direction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC" ]
}
field
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"alias" : {
"type" : "string"
},
"attribute" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"propertyPath" : {
"type" : "string"
},
"transformation" : {
"$ref" : "transform.json"
},
"transformationArgument" : {
"type" : "string"
},
"translate" : {
"type" : "boolean"
}
}
}
fieldBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"alias(String)" : {
"$ref" : "#"
},
"attribute(boolean)" : {
"$ref" : "#"
},
"propertyPath(String)" : {
"$ref" : "#"
},
"transformation(Transform)" : {
"$ref" : "#"
},
"transformationArgument(String)" : {
"$ref" : "#"
},
"translate(boolean)" : {
"$ref" : "#"
}
}
}
filter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "boolean"
},
"group" : {
"type" : "integer"
},
"operator" : {
"$ref" : "comparison.json"
},
"propertyPath" : {
"type" : "string"
},
"value" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
gistQueryBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absoluteUrls(boolean)" : {
"$ref" : "#"
},
"anyFilter(boolean)" : {
"$ref" : "#"
},
"auto(GistAutoType)" : {
"$ref" : "#"
},
"fields(List<Field>)" : {
"$ref" : "#"
},
"filters(List<Filter>)" : {
"$ref" : "#"
},
"headless(boolean)" : {
"$ref" : "#"
},
"inverse(boolean)" : {
"$ref" : "#"
},
"orders(List<Order>)" : {
"$ref" : "#"
},
"pageOffset(int)" : {
"$ref" : "#"
},
"pageSize(int)" : {
"$ref" : "#"
},
"total(boolean)" : {
"$ref" : "#"
},
"translate(boolean)" : {
"$ref" : "#"
}
}
}
order
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"direction" : {
"$ref" : "direction.json"
},
"propertyPath" : {
"type" : "string"
}
}
}
orderBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"direction(Direction)" : {
"$ref" : "#"
},
"propertyPath(String)" : {
"$ref" : "#"
}
}
}
i18nLocale
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"locale" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
icon
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "_2G", "_3G", "_4X4", "AGRICULTURE", "AGRICULTURE_WORKER", "ALERT", "ALERT_CIRCLE", "ALERT_TRIANGLE", "AMBULANCE", "AMBULATORY_CLINIC", "ANCV", "BABY_FEMALE_0203M", "BABY_FEMALE_0306M", "BABY_FEMALE_0609M", "BABY_MALE_0203M", "BABY_MALE_0306M", "BABY_MALE_0609M", "BASIC_MOTORCYCLE", "BIKE", "BILLS", "BLISTER_PILLS_OVAL_X1", "BLISTER_PILLS_OVAL_X14", "BLISTER_PILLS_OVAL_X16", "BLISTER_PILLS_OVAL_X4", "BLISTER_PILLS_ROUND_X1", "BLISTER_PILLS_ROUND_X14", "BLISTER_PILLS_ROUND_X16", "BLISTER_PILLS_ROUND_X4", "BLOOD_A_N", "BLOOD_A_P", "BLOOD_AB_N", "BLOOD_AB_P", "BLOOD_B_N", "BLOOD_B_P", "BLOOD_O_N", "BLOOD_O_P", "BLOOD_PRESSURE", "BLOOD_PRESSURE_2", "BLOOD_PRESSURE_MONITOR", "BLOOD_RH_N", "BLOOD_RH_P", "BOY_0105Y", "BOY_1015Y", "BREEDING_SITES", "CALENDAR", "CARDIOGRAM", "CARDIOGRAM_E", "CERVICAL_CANCER", "CHILD_CARE", "CHILD_PROGRAM", "CHILLS", "CHOLERA", "CHURCH", "CIRCLE_LARGE", "CIRCLE_MEDIUM", "CIRCLE_SMALL", "CITY", "CITY_WORKER", "CLEAN_HANDS", "CLINICAL_A", "CLINICAL_F", "CLINICAL_FE", "COINS", "COLD_CHAIN", "COMMUNICATION", "CONE_TEST_ON_NETS", "CONE_TEST_ON_WALLS", "CONSTRUCTION", "CONSTRUCTION_WORKER", "CONTACT_SUPPORT", "CONTRACEPTIVE_DIAPHRAGM", "CONTRACEPTIVE_INJECTION", "CONTRACEPTIVE_PATCH", "CONTRACEPTIVE_VOUCHER", "COPPER_IUD", "COUGHING", "CREDIT_CARD", "CROSS_COUNTRY_MOTORCYCLE", "DEFAULT", "DHIS2_LOGO", "DIARRHEA", "DISCRIMINATING_CONCENTRATION_BIOASSAYS", "DOCTOR", "DOMESTIC_WORKER", "DONKEY", "DRONE", "ECO_CARE", "ELDERLY", "ELECTRICITY", "EMERGENCY_POST", "EXPECTORATE", "FACTORY_WORKER", "FAMILY_PLANNING", "FEMALE_AND_MALE", "FEMALE_CONDOM", "FEMALE_SEX_WORKER", "FETUS", "FEVER", "FEVER_2", "FEVER_CHILLS", "FOREST", "FOREST_PERSONS", "FORUM", "GIRL_0105Y", "GIRL_1015Y", "GROUP_DISCUSSION_MEETING", "GROUP_DISCUSSION_MEETINGX3", "HAPPY", "HAZARDOUS", "HEADACHE", "HEALTH_WORKER", "HEALTH_WORKER_FORM", "HEART", "HEART_CARDIOGRAM", "HELICOPTER", "HIGH_BARS", "HIGH_LEVEL", "HIV_IND", "HIV_NEG", "HIV_POS", "HIV_SELF_TEST", "HOME", "HORMONAL_RING", "HOSPITAL", "HOSPITALIZED", "HOT_MEAL", "HPV", "I_CERTIFICATE_PAPER", "I_DOCUMENTS_ACCEPTED", "I_DOCUMENTS_DENIED", "I_EXAM_MULTIPLE_CHOICE", "I_EXAM_QUALIFICATION", "I_GROUPS_PERSPECTIVE_CROWD", "I_NOTE_ACTION", "I_SCHEDULE_SCHOOL_DATE_TIME", "I_TRAINING_CLASS", "I_UTENSILS", "IMM", "IMPLANT", "INFO", "INFORMATION_CAMPAIGN", "INPATIENT", "INSECTICIDE_RESISTANCE", "INTENSITY_CONCENTRATION_BIOASSAYS", "IUD", "JUSTICE", "LACTATION", "LETRINA", "LLIN", "LOW_BARS", "LOW_LEVEL", "MACHINERY", "MAGNIFYING_GLASS", "MALARIA_MIXED_MICROSCOPE", "MALARIA_NEGATIVE_MICROSCOPE", "MALARIA_OUTBREAK", "MALARIA_PF_MICROSCOPE", "MALARIA_PV_MICROSCOPE", "MALARIA_TESTING", "MALE_AND_FEMALE", "MALE_CONDOM", "MALE_SEX_WORKER", "MAN", "MARKET_STALL", "MASK", "MEASLES", "MEDICINES", "MEDIUM_BARS", "MEDIUM_LEVEL", "MEGAPHONE", "MENTAL_DISORDERS", "MICROSCOPE", "MILITARY_WORKER", "MINER_WORKER", "MOBILE_CLINIC", "MONEY_BAG", "MOSQUITO", "MOSQUITO_COLLECTION", "MSM", "NAUSEA", "NEGATIVE", "NETWORK_4G", "NETWORK_5G", "NEUROLOGY", "NEUTRAL", "NO", "NOT_OK", "NURSE", "OBSERVATION", "ODONTOLOGY", "ODONTOLOGY_IMPLANT", "OFFICER", "OK", "OLD_MAN", "OLD_WOMAN", "ORAL_CONTRACEPTION_PILLSX21", "ORAL_CONTRACEPTION_PILLSX28", "OUTPATIENT", "OVERWEIGHT", "PALM_BRANCHES_ROOF", "PAVE_ROAD", "PEACE", "PEOPLE", "PERSON", "PHONE", "PILL_1", "PILLS_2", "PILLS_3", "PILLS_4", "PLANTATION_WORKER", "POLYGON", "POSITIVE", "PREGNANT", "PREGNANT_0812W", "PREGNANT_2426W", "PREGNANT_32W", "PREGNANT_3638W", "PRISONER", "PROPER_ROOF", "PROVIDER_FST", "PWID", "QUESTION", "QUESTION_CIRCLE", "QUESTION_TRIANGLE", "RDT_RESULT_INVALID", "RDT_RESULT_MIXED", "RDT_RESULT_MIXED_INVALID", "RDT_RESULT_MIXED_INVALID_RECTANGULAR", "RDT_RESULT_MIXED_RECTANGULAR", "RDT_RESULT_NEG", "RDT_RESULT_NEG_INVALID", "RDT_RESULT_NEG_INVALID_RECTANGULAR", "RDT_RESULT_NEG_RECTANGULAR", "RDT_RESULT_NEGATIVE", "RDT_RESULT_NO_TEST", "RDT_RESULT_OUT_STOCK", "RDT_RESULT_PF", "RDT_RESULT_PF_INVALID", "RDT_RESULT_PF_INVALID_RECTANGULAR", "RDT_RESULT_PF_RECTANGULAR", "RDT_RESULT_POSITIVE", "RDT_RESULT_PV", "RDT_RESULT_PV_INVALID", "RDT_RESULT_PV_INVALID_RECTANGULAR", "RDT_RESULT_PV_RECTANGULAR", "REFERRAL", "REFUSED", "RIBBON", "RMNH", "RUNNING_WATER", "RURAL_POST", "SAD", "SANITIZER", "SAYANA_PRESS", "SECURITY_WORKER", "SEXUAL_REPRODUCTIVE_HEALTH", "SMALL_PLANE", "SOCIAL_DISTANCING", "SPRAYING", "SQUARE_LARGE", "SQUARE_MEDIUM", "SQUARE_SMALL", "STAR_LARGE", "STAR_MEDIUM", "STAR_SMALL", "STETHOSCOPE", "STI", "STOCK_OUT", "STOP", "SURGICAL_STERILIZATION", "SWEATING", "SYMPTOM", "SYNERGIST_INSECTICIDE_BIOASSAYS", "SYRINGE", "TAC", "TB", "TRANSGENDER", "TRAUMATISM", "TRAVEL", "TREATED_WATER", "TRIANGLE_LARGE", "TRIANGLE_MEDIUM", "TRIANGLE_SMALL", "TRUCK_DRIVER", "UN_PAVE_ROAD", "UNDERWEIGHT", "VESPA_MOTORCYCLE", "VIH_AIDS", "VIRUS", "VOMITING", "WAR", "WASH_HANDS", "WATER_SANITATION", "WATER_TREATMENT", "WEIGHT", "WOLD_CARE", "WOMAN", "YES", "YOUNG_PEOPLE" ]
}
iconData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"keywords" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
importStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "UPDATE", "CREATE_AND_UPDATE", "DELETE", "SYNC", "NEW_AND_UPDATES", "NEW", "UPDATES", "DELETES" ]
}
indicator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"annualized" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"decimals" : {
"type" : "integer"
},
"denominator" : {
"type" : "string"
},
"denominatorDescription" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDenominatorDescription" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayNumeratorDescription" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"indicatorType" : {
"$ref" : "indicatorType.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"numerator" : {
"type" : "string"
},
"numeratorDescription" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroupSet" : {
"$ref" : "indicatorGroupSet.json"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"factor" : {
"type" : "integer"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"number" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
refToTypeMapping
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
interpretation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"comments" : {
"type" : "array",
"items" : {
"$ref" : "interpretationComment.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"displayName" : {
"type" : "string"
},
"eventChart" : {
"$ref" : "eventChart.json"
},
"eventReport" : {
"$ref" : "eventReport.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"likedBy" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"likes" : {
"type" : "integer"
},
"map" : {
"$ref" : "map.json"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "mention.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "analyticsFavoriteType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "mention.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
mention
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"username" : {
"type" : "string"
}
}
}
notificationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INTERPRETATION_CREATE", "INTERPRETATION_UPDATE", "INTERPRETATION_LIKE", "COMMENT_CREATE", "COMMENT_UPDATE" ]
}
protectionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "HIDDEN", "RESTRICTED" ]
}
keyJsonValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "string"
}
}
}
leaderNodeInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"currentNodeId" : {
"type" : "string"
},
"currentNodeUuid" : {
"type" : "string"
},
"leader" : {
"type" : "boolean"
},
"leaderNodeId" : {
"type" : "string"
},
"leaderNodeUuid" : {
"type" : "string"
}
}
}
legend
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"color" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"endValue" : {
"type" : "number"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"image" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"startValue" : {
"type" : "number"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
legendDisplayStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FIXED", "BY_DATA_ITEM" ]
}
legendDisplayStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FILL", "TEXT" ]
}
legendSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legends" : {
"type" : "array",
"items" : {
"$ref" : "legend.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"symbolizer" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
eventStatus_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
externalMapLayer
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attribution" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"imageFormat" : {
"$ref" : "imageFormat.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layers" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSetUrl" : {
"type" : "string"
},
"mapLayerPosition" : {
"$ref" : "mapLayerPosition.json"
},
"mapService" : {
"$ref" : "mapService.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PNG", "JPG" ]
}
map
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"basemap" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"mapViews" : {
"type" : "array",
"items" : {
"$ref" : "mapView.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"title" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"zoom" : {
"type" : "integer"
}
}
}
mapLayerPosition
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BASEMAP", "OVERLAY" ]
}
mapService
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WMS", "TMS", "XYZ" ]
}
mapView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"areaRadius" : {
"type" : "integer"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"classes" : {
"type" : "integer"
},
"code" : {
"type" : "string"
},
"colorHigh" : {
"type" : "string"
},
"colorLow" : {
"type" : "string"
},
"colorScale" : {
"type" : "string"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"config" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventClustering" : {
"type" : "boolean"
},
"eventCoordinateField" : {
"type" : "string"
},
"eventPointColor" : {
"type" : "string"
},
"eventPointRadius" : {
"type" : "integer"
},
"eventStatus" : {
"$ref" : "eventStatus_.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"followUp" : {
"type" : "boolean"
},
"formName" : {
"type" : "string"
},
"hidden" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"labelFontColor" : {
"type" : "string"
},
"labelFontSize" : {
"type" : "string"
},
"labelFontStyle" : {
"type" : "string"
},
"labelFontWeight" : {
"type" : "string"
},
"labels" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layer" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"method" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"noDataColor" : {
"type" : "string"
},
"opacity" : {
"type" : "number"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitColor" : {
"type" : "string"
},
"organisationUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnitSelectionMode" : {
"$ref" : "organisationUnitSelectionMode.json"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraph" : {
"type" : "string"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"parentLevel" : {
"type" : "integer"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"radiusHigh" : {
"type" : "integer"
},
"radiusLow" : {
"type" : "integer"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"renderingStrategy" : {
"$ref" : "mapViewRenderingStrategy.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"styleDataItem" : { },
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"thematicMapType" : {
"$ref" : "thematicMapType.json"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
}
}
}
mapViewRenderingStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SINGLE", "SPLIT_BY_PERIOD", "TIMELINE" ]
}
thematicMapType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CHOROPLETH", "BUBBLE" ]
}
message
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "fileResource.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"internal" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"metaData" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sender" : {
"$ref" : "user.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
messageConversation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"assignee" : {
"$ref" : "user.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followUp" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastMessage" : {
"type" : "string",
"format" : "date-time"
},
"lastSender" : {
"$ref" : "user.json"
},
"lastSenderFirstname" : {
"type" : "string"
},
"lastSenderSurname" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageCount" : {
"type" : "integer"
},
"messageType" : {
"$ref" : "messageType_.json"
},
"messages" : {
"type" : "array",
"items" : {
"$ref" : "message.json"
}
},
"name" : {
"type" : "string"
},
"priority" : {
"$ref" : "messageConversationPriority.json"
},
"publicAccess" : {
"type" : "string"
},
"read" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "messageConversationStatus.json"
},
"subject" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userFirstname" : {
"type" : "string"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userMessages" : {
"type" : "array",
"items" : {
"$ref" : "userMessage.json"
}
},
"userSurname" : {
"type" : "string"
}
}
}
messageConversationPriority
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "LOW", "MEDIUM", "HIGH" ]
}
messageConversationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "OPEN", "PENDING", "INVALID", "SOLVED" ]
}
messageType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PRIVATE", "SYSTEM", "VALIDATION_RESULT", "TICKET" ]
}
userMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followUp" : {
"type" : "boolean"
},
"key" : {
"type" : "string"
},
"read" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hashCode" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"importDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "versionType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
versionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BEST_EFFORT", "ATOMIC" ]
}
minMaxDataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElement" : {
"$ref" : "dataElement.json"
},
"generated" : {
"type" : "boolean"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"optionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"source" : {
"$ref" : "organisationUnit.json"
}
}
}
minMaxValueParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSets" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnit" : {
"type" : "string"
}
}
}
nodeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SIMPLE", "COMPLEX", "COLLECTION" ]
}
preset
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "CODE", "ID_NAME", "ALL", "IDENTIFIABLE", "NAMEABLE" ]
}
include
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALWAYS", "NON_NULL", "NON_EMPTY" ]
}
include
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALWAYS", "NON_NULL", "NON_EMPTY" ]
}
expressionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VARIABLE", "TRACKED_ENTITY_ATTRIBUTE", "DATA_ELEMENT" ]
}
sendStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COLLECTIVE_SUMMARY", "SINGLE_NOTIFICATION" ]
}
externalNotificationLogEntry
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowMultiple" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastSentAt" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"notificationTemplateUid" : {
"type" : "string"
},
"notificationTriggeredBy" : {
"$ref" : "notificationTriggerEvent.json"
},
"publicAccess" : {
"type" : "string"
},
"retries" : {
"type" : "integer"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
notificationTriggerEvent
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM", "PROGRAM_STAGE", "DATA_SET", "VALIDATION_RULE" ]
}
option
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"optionGroups" : {
"type" : "array",
"items" : {
"$ref" : "optionGroup.json"
}
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
},
"version" : {
"type" : "integer"
}
}
}
featureType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "MULTI_POLYGON", "POLYGON", "POINT", "SYMBOL" ]
}
organisationUnit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"address" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"ancestors" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"children" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"closedDate" : {
"type" : "string",
"format" : "date-time"
},
"code" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"contactPerson" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"image" : {
"$ref" : "fileResource.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leaf" : {
"type" : "boolean"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"level" : {
"type" : "integer",
"readOnly" : true
},
"memberCount" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"openingDate" : {
"type" : "string",
"format" : "date-time"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"parent" : {
"$ref" : "#"
},
"path" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"phoneNumber" : {
"type" : "string"
},
"programs" : {
"type" : "array",
"items" : {
"$ref" : "program.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
organisationUnitGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"color" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"geometry" : {
"$ref" : "geometry.json"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"symbol" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
organisationUnitGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"includeSubhierarchyInAnalytics" : {
"type" : "boolean"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
organisationUnitGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"organisationUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
}
}
}
organisationUnitLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"level" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"offlineLevels" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
batchResponseStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"summaries" : {
"type" : "array",
"items" : {
"$ref" : "outboundMessageResponseSummary.json"
}
}
}
}
outboundMessageBatchStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMPLETED", "FAILED", "PENDING", "ABORTED" ]
}
outboundMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"async" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"ok" : {
"type" : "boolean"
},
"status" : {
"type" : "string"
}
}
}
outboundMessageResponseSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"batchType" : {
"$ref" : "deliveryChannel.json"
},
"errorMessage" : {
"type" : "string"
},
"failed" : {
"type" : "integer"
},
"pending" : {
"type" : "integer"
},
"responseMessage" : {
"type" : "string"
},
"sent" : {
"type" : "integer"
},
"status" : {
"$ref" : "outboundMessageBatchStatus.json"
},
"total" : {
"type" : "integer"
}
}
}
order_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MEAN_ABS_DEV", "Z_SCORE" ]
}
orgUnitSelection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DESCENDANTS", "SELECTED" ]
}
outlierDetectionAlgorithm
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "Z_SCORE", "MIN_MAX", "MOD_Z_SCORE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"algorithm" : {
"$ref" : "outlierDetectionAlgorithm.json"
},
"count" : {
"type" : "integer"
},
"dataEndDate" : {
"type" : "string",
"format" : "date-time"
},
"dataStartDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"orderBy" : {
"$ref" : "order_.json"
},
"threshold" : {
"type" : "number"
}
}
}
outlierDetectionQuery
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"algorithm" : {
"$ref" : "outlierDetectionAlgorithm.json"
},
"dataEndDate" : {
"type" : "string",
"format" : "date-time"
},
"dataStartDate" : {
"type" : "string",
"format" : "date-time"
},
"de" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"ds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"orderBy" : {
"$ref" : "order_.json"
},
"ou" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"threshold" : {
"type" : "number"
}
}
}
outlierDetectionResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "outlierDetectionMetadata.json"
},
"outlierValues" : {
"type" : "array",
"items" : {
"$ref" : "outlierValue.json"
}
}
}
}
outlierValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absDev" : {
"type" : "number"
},
"aoc" : {
"type" : "string"
},
"aocName" : {
"type" : "string"
},
"coc" : {
"type" : "string"
},
"cocName" : {
"type" : "string"
},
"de" : {
"type" : "string"
},
"deName" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lowerBound" : {
"type" : "number"
},
"mean" : {
"type" : "number"
},
"median" : {
"type" : "number"
},
"ou" : {
"type" : "string"
},
"ouName" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"stdDev" : {
"type" : "number"
},
"upperBound" : {
"type" : "number"
},
"value" : {
"type" : "number"
},
"zScore" : {
"type" : "number"
}
}
}
mutation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"operation" : {
"$ref" : "operation.json"
},
"path" : {
"type" : "string"
},
"value" : { }
}
}
operation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ADDITION", "DELETION" ]
}
patch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"mutations" : {
"type" : "array",
"items" : {
"$ref" : "mutation.json"
}
}
}
}
configurablePeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
period
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
periodType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
relativePeriodEnum
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TODAY", "YESTERDAY", "LAST_3_DAYS", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "LAST_60_DAYS", "LAST_90_DAYS", "LAST_180_DAYS", "THIS_MONTH", "LAST_MONTH", "THIS_BIMONTH", "LAST_BIMONTH", "THIS_QUARTER", "LAST_QUARTER", "THIS_SIX_MONTH", "LAST_SIX_MONTH", "WEEKS_THIS_YEAR", "MONTHS_THIS_YEAR", "BIMONTHS_THIS_YEAR", "QUARTERS_THIS_YEAR", "THIS_YEAR", "MONTHS_LAST_YEAR", "QUARTERS_LAST_YEAR", "LAST_YEAR", "LAST_5_YEARS", "LAST_10_YEARS", "LAST_12_MONTHS", "LAST_6_MONTHS", "LAST_3_MONTHS", "LAST_6_BIMONTHS", "LAST_4_QUARTERS", "LAST_2_SIXMONTHS", "THIS_FINANCIAL_YEAR", "LAST_FINANCIAL_YEAR", "LAST_5_FINANCIAL_YEARS", "LAST_10_FINANCIAL_YEARS", "THIS_WEEK", "LAST_WEEK", "THIS_BIWEEK", "LAST_BIWEEK", "LAST_4_WEEKS", "LAST_4_BIWEEKS", "LAST_12_WEEKS", "LAST_52_WEEKS" ]
}
relativePeriods
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"biMonthsThisYear" : {
"type" : "boolean"
},
"last10FinancialYears" : {
"type" : "boolean"
},
"last10Years" : {
"type" : "boolean"
},
"last12Months" : {
"type" : "boolean"
},
"last12Weeks" : {
"type" : "boolean"
},
"last14Days" : {
"type" : "boolean"
},
"last180Days" : {
"type" : "boolean"
},
"last2SixMonths" : {
"type" : "boolean"
},
"last30Days" : {
"type" : "boolean"
},
"last3Days" : {
"type" : "boolean"
},
"last3Months" : {
"type" : "boolean"
},
"last4BiWeeks" : {
"type" : "boolean"
},
"last4Quarters" : {
"type" : "boolean"
},
"last4Weeks" : {
"type" : "boolean"
},
"last52Weeks" : {
"type" : "boolean"
},
"last5FinancialYears" : {
"type" : "boolean"
},
"last5Years" : {
"type" : "boolean"
},
"last60Days" : {
"type" : "boolean"
},
"last6BiMonths" : {
"type" : "boolean"
},
"last6Months" : {
"type" : "boolean"
},
"last7Days" : {
"type" : "boolean"
},
"last90Days" : {
"type" : "boolean"
},
"lastBiWeek" : {
"type" : "boolean"
},
"lastBimonth" : {
"type" : "boolean"
},
"lastFinancialYear" : {
"type" : "boolean"
},
"lastMonth" : {
"type" : "boolean"
},
"lastQuarter" : {
"type" : "boolean"
},
"lastSixMonth" : {
"type" : "boolean"
},
"lastWeek" : {
"type" : "boolean"
},
"lastYear" : {
"type" : "boolean"
},
"monthsLastYear" : {
"type" : "boolean"
},
"monthsThisYear" : {
"type" : "boolean"
},
"quartersLastYear" : {
"type" : "boolean"
},
"quartersThisYear" : {
"type" : "boolean"
},
"thisBiWeek" : {
"type" : "boolean"
},
"thisBimonth" : {
"type" : "boolean"
},
"thisDay" : {
"type" : "boolean"
},
"thisFinancialYear" : {
"type" : "boolean"
},
"thisMonth" : {
"type" : "boolean"
},
"thisQuarter" : {
"type" : "boolean"
},
"thisSixMonth" : {
"type" : "boolean"
},
"thisWeek" : {
"type" : "boolean"
},
"thisYear" : {
"type" : "boolean"
},
"weeksThisYear" : {
"type" : "boolean"
},
"yesterday" : {
"type" : "boolean"
}
}
}
predictor
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"annualSampleCount" : {
"type" : "integer"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"generator" : {
"$ref" : "expression.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitLevel.json"
}
},
"output" : {
"$ref" : "dataElement.json"
},
"outputCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"periodType" : {
"$ref" : "periodType.json"
},
"predictorGroups" : {
"type" : "array",
"items" : {
"$ref" : "predictorGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sampleSkipTest" : {
"$ref" : "expression.json"
},
"sequentialSampleCount" : {
"type" : "integer"
},
"sequentialSkipCount" : {
"type" : "integer"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
predictorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"predictors" : {
"type" : "array",
"items" : {
"$ref" : "predictor.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
preheatErrorReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"errorKlass" : {
"type" : "string"
},
"errorProperties" : {
"type" : "array",
"items" : { }
},
"errorProperty" : {
"type" : "string"
},
"mainId" : {
"type" : "string"
},
"mainKlass" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"value" : { }
}
}
preheatIdentifier
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UID", "CODE" ]
}
preheatMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "REFERENCE", "ALL", "NONE" ]
}
analyticsPeriodBoundary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"analyticsPeriodBoundaryType" : {
"$ref" : "analyticsPeriodBoundaryType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"boundaryTarget" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"offsetPeriodType" : {
"$ref" : "periodType.json"
},
"offsetPeriods" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
analyticsPeriodBoundaryType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BEFORE_START_OF_REPORTING_PERIOD", "BEFORE_END_OF_REPORTING_PERIOD", "AFTER_START_OF_REPORTING_PERIOD", "AFTER_END_OF_REPORTING_PERIOD" ]
}
analyticsType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT" ]
}
program
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accessLevel" : {
"$ref" : "accessLevel.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"completeEventsExpiryDays" : {
"type" : "integer"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayEnrollmentDateLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayFrontPageList" : {
"type" : "boolean"
},
"displayIncidentDate" : {
"type" : "boolean"
},
"displayIncidentDateLabel" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"enrollmentDateLabel" : {
"type" : "string"
},
"expiryDays" : {
"type" : "integer"
},
"expiryPeriodType" : {
"$ref" : "periodType.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"ignoreOverdueEvents" : {
"type" : "boolean"
},
"incidentDateLabel" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"maxTeiCountToReturn" : {
"type" : "integer"
},
"minAttributesRequiredToSearch" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"onlyEnrollOnce" : {
"type" : "boolean"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programRuleVariables" : {
"type" : "array",
"items" : {
"$ref" : "programRuleVariable.json"
}
},
"programSections" : {
"type" : "array",
"items" : {
"$ref" : "programSection.json"
}
},
"programStages" : {
"type" : "array",
"items" : {
"$ref" : "programStage.json"
}
},
"programTrackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttribute.json"
}
},
"programType" : {
"$ref" : "programType.json"
},
"publicAccess" : {
"type" : "string"
},
"registration" : {
"type" : "boolean"
},
"relatedProgram" : {
"$ref" : "#"
},
"selectEnrollmentDatesInFuture" : {
"type" : "boolean"
},
"selectIncidentDatesInFuture" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipOffline" : {
"type" : "boolean"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"useFirstStageDuringRegistration" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"version" : {
"type" : "integer"
},
"withoutRegistration" : {
"type" : "boolean"
}
}
}
programDataElementDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programExpression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"expression" : {
"type" : "string"
}
}
}
programIndicator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"analyticsPeriodBoundaries" : {
"type" : "array",
"items" : {
"$ref" : "analyticsPeriodBoundary.json"
}
},
"analyticsType" : {
"$ref" : "analyticsType_.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"decimals" : {
"type" : "integer"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInForm" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "programIndicatorGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programIndicatorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"completedBy" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"enrollmentDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"incidentDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"messageConversations" : {
"type" : "array",
"items" : {
"$ref" : "messageConversation.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"programStageInstances" : {
"type" : "array",
"items" : {
"$ref" : "programStageInstance.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "programStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityComments" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityComment.json"
}
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programOwnershipHistory
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"createdBy" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"entityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
}
}
}
programSection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttribute.json"
}
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowGenerateNextVisit" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"autoGenerateEvent" : {
"type" : "boolean"
},
"blockEntryForm" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDueDateLabel" : {
"type" : "string"
},
"displayExecutionDateLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayGenerateEventBox" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"dueDateLabel" : {
"type" : "string"
},
"enableUserAssignment" : {
"type" : "boolean"
},
"executionDateLabel" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"formType" : {
"$ref" : "formType.json"
},
"generatedByEnrollmentDate" : {
"type" : "boolean"
},
"hideDueDate" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"minDaysFromStart" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"nextScheduleDate" : {
"$ref" : "dataElement.json"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"openAfterEnrollment" : {
"type" : "boolean"
},
"periodType" : {
"$ref" : "periodType.json"
},
"preGenerateUID" : {
"type" : "boolean"
},
"program" : {
"$ref" : "program.json"
},
"programStageDataElements" : {
"type" : "array",
"items" : {
"$ref" : "programStageDataElement.json"
}
},
"programStageSections" : {
"type" : "array",
"items" : {
"$ref" : "programStageSection.json"
}
},
"publicAccess" : {
"type" : "string"
},
"remindCompleted" : {
"type" : "boolean"
},
"repeatable" : {
"type" : "boolean"
},
"reportDateToUse" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"standardInterval" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationStrategy" : {
"$ref" : "validationStrategy.json"
}
}
}
programStageDataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowFutureDate" : {
"type" : "boolean"
},
"allowProvidedElsewhere" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayInReports" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"renderOptionsAsRadio" : {
"type" : "boolean"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skipAnalytics" : {
"type" : "boolean"
},
"skipSynchronization" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"assignedUser" : {
"$ref" : "user.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"comments" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityComment.json"
}
},
"completed" : {
"type" : "boolean"
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string",
"format" : "date-time"
},
"creatableInSearchScope" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"dueDate" : {
"type" : "string",
"format" : "date-time"
},
"eventDataValues" : {
"type" : "array",
"items" : {
"$ref" : "eventDataValue.json"
}
},
"eventDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"messageConversations" : {
"type" : "array",
"items" : {
"$ref" : "messageConversation.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "eventStatus.json"
},
"storedBy" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageSection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
programTempOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"reason" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"validTill" : {
"type" : "string",
"format" : "date-time"
}
}
}
programTempOwnershipAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"accessedBy" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"reason" : {
"type" : "string"
}
}
}
programTrackedEntityAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowFutureDate" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayInList" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"programTrackedEntityAttributeGroups" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttributeGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"renderOptionsAsRadio" : {
"type" : "boolean"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"searchable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sortOrder" : {
"type" : "integer"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programTrackedEntityAttributeDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programTrackedEntityAttributeGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttribute.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"uniqunessType" : {
"$ref" : "uniqunessType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WITH_REGISTRATION", "WITHOUT_REGISTRATION" ]
}
uniqunessType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "STRICT", "VALIDATION" ]
}
userInfoSnapshot
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"firstName" : {
"type" : "string"
},
"surname" : {
"type" : "string"
},
"uid" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
}
}
validationStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ON_COMPLETE", "ON_UPDATE_AND_INSERT" ]
}
programMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageStatus" : {
"$ref" : "programMessageStatus.json"
},
"name" : {
"type" : "string"
},
"notificationTemplate" : {
"type" : "string"
},
"processedDate" : {
"type" : "string",
"format" : "date-time"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"publicAccess" : {
"type" : "string"
},
"recipients" : {
"$ref" : "programMessageRecipients.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"storeCopy" : {
"type" : "boolean"
},
"subject" : {
"type" : "string"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programMessageBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deliveryChannels(Set<DeliveryChannel>)" : {
"$ref" : "#"
},
"messageStatus(ProgramMessageStatus)" : {
"$ref" : "#"
},
"notificationTemplate(String)" : {
"$ref" : "#"
},
"processedDate(Date)" : {
"$ref" : "#"
},
"programInstance(ProgramInstance)" : {
"$ref" : "#"
},
"programStageInstance(ProgramStageInstance)" : {
"$ref" : "#"
},
"recipients(ProgramMessageRecipients)" : {
"$ref" : "#"
},
"storeCopy(boolean)" : {
"$ref" : "#"
},
"subject(String)" : {
"$ref" : "#"
},
"text(String)" : {
"$ref" : "#"
}
}
}
programMessageBatch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"programMessages" : {
"type" : "array",
"items" : {
"$ref" : "programMessage.json"
}
}
}
}
programMessageCategory
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCOMING", "OUTGOING" ]
}
programMessageRecipients
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"emailAddresses" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"phoneNumbers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
programMessageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SENT", "FAILED", "SCHEDULED", "OUTBOUND" ]
}
notificationTrigger
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ENROLLMENT", "COMPLETION", "PROGRAM_RULE", "SCHEDULED_DAYS_DUE_DATE", "SCHEDULED_DAYS_INCIDENT_DATE", "SCHEDULED_DAYS_ENROLLMENT_DATE" ]
}
programNotificationInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programNotificationTemplateId" : {
"type" : "integer"
},
"programNotificationTemplateSnapshot" : {
"$ref" : "programNotificationTemplateSnapshot.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"publicAccess" : {
"type" : "string"
},
"scheduledAt" : {
"type" : "string",
"format" : "date-time"
},
"sentAt" : {
"type" : "string",
"format" : "date-time"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "ORGANISATION_UNIT_CONTACT", "USERS_AT_ORGANISATION_UNIT", "USER_GROUP", "PROGRAM_ATTRIBUTE", "DATA_ELEMENT", "WEB_HOOK" ]
}
programNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "ORGANISATION_UNIT_CONTACT", "USERS_AT_ORGANISATION_UNIT", "USER_GROUP", "PROGRAM_ATTRIBUTE", "DATA_ELEMENT", "WEB_HOOK" ]
}
programNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "programNotificationRecipient.json"
},
"notificationTrigger" : {
"$ref" : "notificationTrigger.json"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientDataElement" : {
"$ref" : "dataElement.json"
},
"recipientProgramAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"recipientUserGroup" : {
"$ref" : "userGroup.json"
},
"relativeScheduledDays" : {
"type" : "integer"
},
"sendRepeatable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "PROGRAM_STAGE_NAME", "ORG_UNIT_NAME", "DUE_DATE", "DAYS_SINCE_DUE_DATE", "DAYS_UNTIL_DUE_DATE", "CURRENT_DATE", "EVENT_DATE", "PROGRAM_ID", "EVENT_ORG_UNIT_ID", "ENROLLMENT_ORG_UNIT_ID", "PROGRAM_STAGE_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programStageTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "PROGRAM_STAGE_NAME", "ORG_UNIT_NAME", "DUE_DATE", "DAYS_SINCE_DUE_DATE", "DAYS_UNTIL_DUE_DATE", "CURRENT_DATE", "EVENT_DATE", "PROGRAM_ID", "EVENT_ORG_UNIT_ID", "ENROLLMENT_ORG_UNIT_ID", "PROGRAM_STAGE_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "ORG_UNIT_NAME", "CURRENT_DATE", "ENROLLMENT_DATE", "DAYS_SINCE_ENROLLMENT_DATE", "INCIDENT_DATE", "PROGRAM_ID", "ENROLLMENT_ORG_UNIT_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "ORG_UNIT_NAME", "CURRENT_DATE", "ENROLLMENT_DATE", "DAYS_SINCE_ENROLLMENT_DATE", "INCIDENT_DATE", "PROGRAM_ID", "ENROLLMENT_ORG_UNIT_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programNotificationTemplateSnapshot
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"messageTemplate" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "programNotificationRecipient.json"
},
"notificationTrigger" : {
"$ref" : "notificationTrigger.json"
},
"sendRepeatable" : {
"type" : "boolean"
},
"subjectTemplate" : {
"type" : "string"
}
}
}
programRule
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"condition" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"priority" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"programRuleActions" : {
"type" : "array",
"items" : {
"$ref" : "programRuleAction.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleAction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"content" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"data" : {
"type" : "string"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayContent" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"location" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"option" : {
"$ref" : "option.json"
},
"optionGroup" : {
"$ref" : "optionGroup.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
},
"programRule" : {
"$ref" : "programRule.json"
},
"programRuleActionEvaluationEnvironments" : {
"type" : "array",
"items" : {
"$ref" : "programRuleActionEvaluationEnvironment.json"
}
},
"programRuleActionEvaluationTime" : {
"$ref" : "programRuleActionEvaluationTime.json"
},
"programRuleActionType" : {
"$ref" : "programRuleActionType.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStageSection" : {
"$ref" : "programStageSection.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"templateUid" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleActionEvaluationEnvironment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WEB", "ANDROID" ]
}
programRuleActionEvaluationTime
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ON_DATA_ENTRY", "ON_COMPLETE", "ALWAYS" ]
}
programRuleActionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DISPLAYTEXT", "DISPLAYKEYVALUEPAIR", "HIDEFIELD", "HIDESECTION", "HIDEPROGRAMSTAGE", "ASSIGN", "SHOWWARNING", "WARNINGONCOMPLETE", "SHOWERROR", "ERRORONCOMPLETE", "CREATEEVENT", "SETMANDATORYFIELD", "SENDMESSAGE", "SCHEDULEMESSAGE", "HIDEOPTION", "SHOWOPTIONGROUP", "HIDEOPTIONGROUP" ]
}
programRuleVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"programRuleVariableSourceType" : {
"$ref" : "programRuleVariableSourceType.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"useCodeForOptionSet" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleVariableSourceType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATAELEMENT_NEWEST_EVENT_PROGRAM_STAGE", "DATAELEMENT_NEWEST_EVENT_PROGRAM", "DATAELEMENT_CURRENT_EVENT", "DATAELEMENT_PREVIOUS_EVENT", "CALCULATED_VALUE", "TEI_ATTRIBUTE" ]
}
dateFilterPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"endBuffer" : {
"type" : "integer"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"period" : {
"$ref" : "relativePeriodEnum.json"
},
"startBuffer" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"type" : {
"$ref" : "datePeriodType.json"
}
}
}
datePeriodType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RELATIVE", "ABSOLUTE" ]
}
eventDataFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataItem" : {
"type" : "string"
},
"dateFilter" : {
"$ref" : "dateFilterPeriod.json"
},
"eq" : {
"type" : "string"
},
"ge" : {
"type" : "string"
},
"gt" : {
"type" : "string"
},
"in" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"le" : {
"type" : "string"
},
"like" : {
"type" : "string"
},
"lt" : {
"type" : "string"
}
}
}
eventQueryCriteria
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUserMode" : {
"$ref" : "assignedUserSelectionMode.json"
},
"assignedUsers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"completedDate" : {
"$ref" : "dateFilterPeriod.json"
},
"dataFilters" : {
"type" : "array",
"items" : {
"$ref" : "eventDataFilter.json"
}
},
"displayColumnOrder" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dueDate" : {
"$ref" : "dateFilterPeriod.json"
},
"eventDate" : {
"$ref" : "dateFilterPeriod.json"
},
"events" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followUp" : {
"type" : "boolean"
},
"lastUpdatedDate" : {
"$ref" : "dateFilterPeriod.json"
},
"order" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"ouMode" : {
"$ref" : "organisationUnitSelectionMode.json"
},
"status" : {
"$ref" : "eventStatus.json"
}
}
}
programStageInstanceFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"eventQueryCriteria" : {
"$ref" : "eventQueryCriteria.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
pushAnalysis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboard" : {
"$ref" : "dashboard.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"message" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"title" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
schedulingFrequency
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "MONTHLY" ]
}
direction_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASCENDING", "DESCENDING" ]
}
stringSearchMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EQUALS", "NOT_EQUALS", "ANYWHERE", "NOT_ANYWHERE", "STARTING_LIKE", "NOT_STARTING_LIKE", "LIKE", "NOT_LIKE", "ENDING_LIKE", "NOT_ENDING_LIKE" ]
}
type
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AND", "OR" ]
}
matchMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EXACT", "START", "END", "ANYWHERE" ]
}
relationship_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"from" : {
"$ref" : "relationshipItem_.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"relationshipType" : {
"$ref" : "relationshipType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"to" : {
"$ref" : "relationshipItem_.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
relationshipConstraint
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"program" : {
"$ref" : "program.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"relationshipEntity" : {
"$ref" : "relationshipEntity.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
}
}
}
relationshipEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "PROGRAM_INSTANCE", "PROGRAM_STAGE_INSTANCE" ]
}
relationshipItem_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"relationship" : {
"$ref" : "relationship_.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
relationshipType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"bidirectional" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayFromToName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayToFromName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fromConstraint" : {
"$ref" : "relationshipConstraint.json"
},
"fromToName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"toConstraint" : {
"$ref" : "relationshipConstraint.json"
},
"toFromName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
deviceRenderTypeMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
objectValueTypeRenderingOption
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"clazz" : {
"type" : "string"
},
"hasOptionSet" : {
"type" : "boolean"
},
"renderingTypes" : {
"type" : "array",
"items" : {
"$ref" : "valueTypeRenderingType.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
renderDevice
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DESKTOP", "MOBILE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "JSON", "XML", "CSV" ]
}
sectionRenderingObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"$ref" : "sectionRenderingType.json"
}
}
}
sectionRenderingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LISTING", "SEQUENTIAL", "MATRIX" ]
}
valueTypeRenderingObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"decimalPoints" : {
"type" : "integer"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"step" : {
"type" : "integer"
},
"type" : {
"$ref" : "valueTypeRenderingType.json"
}
}
}
valueTypeRenderingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DEFAULT", "DROPDOWN", "VERTICAL_RADIOBUTTONS", "HORIZONTAL_RADIOBUTTONS", "VERTICAL_CHECKBOXES", "HORIZONTAL_CHECKBOXES", "SHARED_HEADER_RADIOBUTTONS", "ICONS_AS_BUTTONS", "SPINNER", "ICON", "TOGGLE", "VALUE", "SLIDER", "LINEAR_SCALE", "AUTOCOMPLETE", "QR_CODE", "BAR_CODE" ]
}
report
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cacheStrategy" : {
"$ref" : "cacheStrategy.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"designContent" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"reportParams" : {
"$ref" : "reportingParams.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "reportType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
}
}
}
reportType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "JASPER_REPORT_TABLE", "JASPER_JDBC", "HTML" ]
}
reservedValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"expiryDate" : {
"type" : "string",
"format" : "date-time"
},
"key" : {
"type" : "string"
},
"ownerObject" : {
"type" : "string"
},
"ownerUid" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
resourceTableType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORG_UNIT_STRUCTURE", "DATA_SET_ORG_UNIT_CATEGORY", "CATEGORY_OPTION_COMBO_NAME", "DATA_ELEMENT_GROUP_SET_STRUCTURE", "INDICATOR_GROUP_SET_STRUCTURE", "ORG_UNIT_GROUP_SET_STRUCTURE", "CATEGORY_STRUCTURE", "DATA_ELEMENT_STRUCTURE", "PERIOD_STRUCTURE", "DATE_PERIOD_STRUCTURE", "DATA_ELEMENT_CATEGORY_OPTION_COMBO", "DATA_APPROVAL_REMAP_LEVEL", "DATA_APPROVAL_MIN_LEVEL" ]
}
itemValueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NUMBER", "DATE", "TEXT", "BOOLEAN" ]
}
ruleEngineIntent
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVALUATION", "DESCRIPTION" ]
}
gS1Elements
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "GS1_E0_IDENTIFIER", "GS1_E1_IDENTIFIER", "GS1_E2_IDENTIFIER", "GS1_E3_IDENTIFIER", "GS1_E4_IDENTIFIER", "GS1_I1_IDENTIFIER", "GS1_C1_IDENTIFIER", "GS1_e0_IDENTIFIER", "GS1_e1_IDENTIFIER", "GS1_e2_IDENTIFIER", "GS1_d2_IDENTIFIER", "GS1_Q3_IDENTIFIER", "GS1_J1_IDENTIFIER", "GS1_d1_IDENTIFIER", "GS1_Q1_IDENTIFIER", "GS1_GROUP_SEPARATOR", "SSCC", "GTIN", "CONTENT", "LOT_NUMBER", "PROD_DATE", "DUE_DATE", "PACK_DATE", "BEST_BEFORE_DATE", "SELL_BY", "EXP_DATE", "VARIANT", "SERIAL_NUMBER", "CPV", "TPX", "ADDITIONAL_ID", "CUSTOMER_PART_NUMBER", "MTO_VARIANT_NUMBER", "PCN", "SECONDARY_SERIAL", "REF_TO_SOURCE", "GDTI", "GLN_EXTENSION_COMPONENT", "GCN", "VAR_COUNT", "NET_WEIGHT_KG", "LENGTH_M", "WIDTH_M", "HEIGHT_M", "AREA_M2", "NET_VOLUME_L", "NET_VOLUME_M3", "NET_WEIGHT_LB", "LENGTH_I", "LENGTH_F", "LENGTH_Y", "WIDTH_I", "WIDTH_F", "WIDTH_Y", "HEIGHT_I", "HEIGHT_F", "HEIGHT_Y", "GROSS_WEIGHT_GF", "LENGTH_M_LOG", "WIDTH_M_LOG", "HEIGHT_M_LOG", "AREA_M2_LOG", "VOLUME_L_LOG", "VOLUME_M3_LOG", "KG_PER_M2", "GROSS_WHEIGHT_LB", "LENGTH_I_LOG", "LENGTH_F_LOG", "LENGTH_Y_LOG", "WIDTH_I_LOG", "WIDTH_F_LOG", "WIDTH_Y_LOG", "HEIGHT_I_LOG", "HEIGHT_F_LOG", "HEIGHT_Y_LOG", "AREA_I2", "AREA_F2", "AREA_Y2", "AREA_I2_LOG", "AREA_F2_LOG", "AREA_Y2_LOG", "NET_WEIGHT_T", "NET_VOLUME_OZ", "NET_VOLUME_Q", "NET_VOLUME_G", "VOLUME_Q_LOG", "VOLUME_G_LOG", "VOLUME_I3", "VOLUME_F3", "VOLUME_Y3", "VOLUME_I3_LOG", "VOLUME_F3_LOG", "VOLUME_Y3_LOG", "COUNT", "AMOUNT", "AMOUNT_ISO", "PRICE", "PRICE_ISO", "PRCNT_OFF", "PRICE_UOM", "ORDER_NUMBER", "GINC", "ROUTE", "SHIP_TO_GLOB_LOC", "BILL_TO_LOC", "PURCHASED_FROM", "SHIP_FOR_LOG", "LOC_NUMBER", "PAY_TO", "PROD_SERV_LOC", "PARTY", "SHIP_TO_POST", "SHIP_TO_POST_ISO", "ORIGIN", "COUNTRY_INITIAL_PROCESS", "COUNTRY_PROCESS", "COUNTRY_DISASSEMBLY", "COUNTRY_FULL_PROCESS", "ORIGIN_SUBDIVISION", "SHIP_TO_COMP", "SHIP_TO_NAME", "SHIP_TO_ADD1", "SHIP_TO_ADD2", "SHIP_TO_SUB", "SHIP_TO_LOCALITY", "SHIP_TO_REG", "SHIP_TO_COUNTRY", "SHIP_TO_PHONE", "RTN_TO_COMP", "RTN_TO_NAME", "RTN_TO_ADD1", "RTN_TO_ADD2", "RTN_TO_SUB", "RTN_TO_LOCALITY", "RTN_TO_REG", "RTN_TO_COUNTRY", "RTN_TO_POST", "RTN_TO_PHONE", "SRV_DESCRIPTION", "DANGEROUS_GOODS", "AUTH_LEAV", "SIG_REQUIRED", "NBEF_DEL_DT", "NAFT_DEL_DT", "REL_DATE", "NSN", "MEAT_CUT", "EXP_TIME", "ACTIVE_POTENCY", "CATCH_AREA", "FIRST_FREEZE_DATE", "HARVEST_DATE", "AQUATIC_SPECIES", "FISHING_GEAR_TYPE", "PROD_METHID", "REFURB_LOT", "FUNC_STAT", "REV_STAT", "GIAI_ASSEMBLY", "PROCESSOR_NUMBER", "UIC_EXT", "NHRN_PZN", "NHRN_CIP", "NHRN_CN", "NHRN_DRN", "NHRN_AIM", "CERT_NUMBER", "PROTOCOL", "DIMENSIONS", "CMT_NUMBER", "GRAI", "GIAI", "PRICE_PER_UNIT", "ITIP", "IBAN", "PROD_TIME", "OPTSEN", "CPID", "CPID_SERIAL", "VERSION", "GMN", "GSRN_PROVIDER", "GSRN_RECIPIENT", "SRIN", "REF_NUMBER", "ITIP_CONTENT", "COUPON_USA", "POINTS", "POSITIVE_OFFER_COUPON_USA", "PRODUCT_URL", "AGREEMENT_INTERNAL", "COMPANY_INTERNAL_1", "COMPANY_INTERNAL_2", "COMPANY_INTERNAL_3", "COMPANY_INTERNAL_4", "COMPANY_INTERNAL_5", "COMPANY_INTERNAL_6", "COMPANY_INTERNAL_7", "COMPANY_INTERNAL_8", "COMPANY_INTERNAL_9" ]
}
attributeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT", "TRACKED_ENTITY_ATTRIBUTE", "UNKNOWN" ]
}
status_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
status__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "SCHEDULE", "SKIPPED", "VISITED", "OVERDUE" ]
}
ruleValueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "NUMERIC", "BOOLEAN", "DATE" ]
}
supplementaryDataKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "USER", "ANDROID_VERSION" ]
}
trackerObjectType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT" ]
}
triggerEnvironment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ANDROIDCLIENT", "SERVER" ]
}
jobConfiguration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"configurable" : {
"type" : "boolean",
"readOnly" : true
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cronExpression" : {
"type" : "string"
},
"delay" : {
"type" : "integer"
},
"displayName" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"jobParameters" : {
"anyOf" : [ {
"$ref" : "analyticsJobParameters.json"
}, {
"$ref" : "continuousAnalyticsJobParameters.json"
}, {
"$ref" : "monitoringJobParameters.json"
}, {
"$ref" : "predictorJobParameters.json"
}, {
"$ref" : "pushAnalysisJobParameters.json"
}, {
"$ref" : "smsJobParameters.json"
}, {
"$ref" : "metadataSyncJobParameters.json"
}, {
"$ref" : "eventProgramsDataSynchronizationJobParameters.json"
}, {
"$ref" : "trackerProgramsDataSynchronizationJobParameters.json"
}, {
"$ref" : "dataSynchronizationJobParameters.json"
}, {
"$ref" : "disableInactiveUsersJobParameters.json"
} ]
},
"jobStatus" : {
"$ref" : "jobStatus.json"
},
"jobType" : {
"$ref" : "jobType.json"
},
"lastExecuted" : {
"type" : "string",
"readOnly" : true,
"format" : "date-time"
},
"lastExecutedStatus" : {
"$ref" : "jobStatus.json"
},
"lastRuntimeExecution" : {
"type" : "string",
"readOnly" : true
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leaderOnlyJob" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"nextExecutionTime" : {
"type" : "string",
"readOnly" : true,
"format" : "date-time"
},
"publicAccess" : {
"type" : "string"
},
"schedulingType" : {
"$ref" : "schedulingType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userUid" : {
"type" : "string",
"readOnly" : true
}
}
}
jobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
jobStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RUNNING", "COMPLETED", "STOPPED", "SCHEDULED", "DISABLED", "FAILED", "NOT_STARTED" ]
}
jobType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_STATISTICS", "DATA_INTEGRITY", "RESOURCE_TABLE", "ANALYTICS_TABLE", "CONTINUOUS_ANALYTICS_TABLE", "DATA_SYNC", "TRACKER_PROGRAMS_DATA_SYNC", "EVENT_PROGRAMS_DATA_SYNC", "FILE_RESOURCE_CLEANUP", "IMAGE_PROCESSING", "META_DATA_SYNC", "SMS_SEND", "SEND_SCHEDULED_MESSAGE", "PROGRAM_NOTIFICATIONS", "VALIDATION_RESULTS_NOTIFICATION", "CREDENTIALS_EXPIRY_ALERT", "MONITORING", "PUSH_ANALYSIS", "PREDICTOR", "DATA_SET_NOTIFICATION", "REMOVE_USED_OR_EXPIRED_RESERVED_VALUES", "TRACKER_IMPORT_JOB", "TRACKER_IMPORT_NOTIFICATION_JOB", "TRACKER_IMPORT_RULE_ENGINE_JOB", "LEADER_ELECTION", "LEADER_RENEWAL", "COMPLETE_DATA_SET_REGISTRATION_IMPORT", "DATAVALUE_IMPORT_INTERNAL", "METADATA_IMPORT", "DATAVALUE_IMPORT", "EVENT_IMPORT", "ENROLLMENT_IMPORT", "TEI_IMPORT", "DISABLE_INACTIVE_USERS", "ACCOUNT_EXPIRY_ALERT", "MOCK", "GML_IMPORT", "ANALYTICSTABLE_UPDATE", "PROGRAM_DATA_SYNC" ]
}
jobTypeInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"jobParameters" : {
"type" : "array",
"items" : {
"$ref" : "property.json"
}
},
"jobType" : {
"$ref" : "jobType.json"
},
"name" : {
"type" : "string"
},
"schedulingType" : {
"$ref" : "schedulingType.json"
}
}
}
schedulingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CRON", "FIXED_DELAY" ]
}
analyticsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastYears" : {
"type" : "integer"
},
"skipPrograms" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipResourceTables" : {
"type" : "boolean"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
continuousAnalyticsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fullUpdateHourOfDay" : {
"type" : "integer"
},
"lastYears" : {
"type" : "integer"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
dataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
disableInactiveUsersJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"inactiveMonths" : {
"type" : "integer"
},
"reminderDaysBefore" : {
"type" : "integer"
}
},
"required" : [ "inactiveMonths" ]
}
eventProgramsDataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataValuesPageSize" : {
"type" : "integer"
},
"eventProgramPageSize" : {
"type" : "integer"
},
"trackerProgramPageSize" : {
"type" : "integer"
}
}
}
mockJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
}
}
}
monitoringJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistResults" : {
"type" : "boolean"
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
},
"sendNotifications" : {
"type" : "boolean"
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
predictorJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"predictorGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"predictors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
}
}
}
pushAnalysisJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pushAnalysis" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "pushAnalysis" ]
}
smsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"recipientsList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"smsSubject" : {
"type" : "string"
}
}
}
trackerProgramsDataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastYears" : {
"type" : "integer"
},
"skipPrograms" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipResourceTables" : {
"type" : "boolean"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
customJobParameters_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fullUpdateHourOfDay" : {
"type" : "integer"
},
"lastYears" : {
"type" : "integer"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
customJobParameters__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters___
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"inactiveMonths" : {
"type" : "integer"
},
"reminderDaysBefore" : {
"type" : "integer"
}
},
"required" : [ "inactiveMonths" ]
}
customJobParameters____
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters_____
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataValuesPageSize" : {
"type" : "integer"
},
"eventProgramPageSize" : {
"type" : "integer"
},
"trackerProgramPageSize" : {
"type" : "integer"
}
}
}
customJobParameters______
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistResults" : {
"type" : "boolean"
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
},
"sendNotifications" : {
"type" : "boolean"
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
customJobParameters_______
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"predictorGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"predictors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
}
}
}
customJobParameters________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pushAnalysis" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "pushAnalysis" ]
}
customJobParameters_________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"recipientsList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"smsSubject" : {
"type" : "string"
}
}
}
customJobParameters__________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
gistPreferences
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"included" : {
"$ref" : "include_.json"
},
"transformation" : {
"$ref" : "transform.json"
}
}
}
property
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"analyticalObject" : {
"type" : "boolean"
},
"apiEndpoint" : {
"type" : "string"
},
"attribute" : {
"type" : "boolean"
},
"cascade" : {
"type" : "string"
},
"collection" : {
"type" : "boolean"
},
"collectionName" : {
"type" : "string"
},
"collectionWrapping" : {
"type" : "boolean"
},
"constants" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"defaultValue" : { },
"description" : {
"type" : "string"
},
"embeddedObject" : {
"type" : "boolean"
},
"fieldName" : {
"type" : "string"
},
"gistPreferences" : {
"$ref" : "gistPreferences.json"
},
"href" : {
"type" : "string"
},
"i18nTranslationKey" : {
"type" : "string"
},
"identifiableObject" : {
"type" : "boolean"
},
"inverseRole" : {
"type" : "string"
},
"itemKlass" : {
"type" : "string"
},
"itemPropertyType" : {
"$ref" : "propertyType.json"
},
"klass" : {
"type" : "string"
},
"length" : {
"type" : "integer"
},
"manyToMany" : {
"type" : "boolean"
},
"manyToOne" : {
"type" : "boolean"
},
"max" : {
"type" : "number"
},
"min" : {
"type" : "number"
},
"name" : {
"type" : "string"
},
"nameableObject" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"oneToMany" : {
"type" : "boolean"
},
"oneToOne" : {
"type" : "boolean"
},
"ordered" : {
"type" : "boolean"
},
"owner" : {
"type" : "boolean"
},
"owningRole" : {
"type" : "string"
},
"persisted" : {
"type" : "boolean"
},
"propertyTransformer" : {
"type" : "boolean"
},
"propertyType" : {
"$ref" : "propertyType.json"
},
"readable" : {
"type" : "boolean"
},
"relativeApiEndpoint" : {
"type" : "string"
},
"required" : {
"type" : "boolean"
},
"simple" : {
"type" : "boolean"
},
"translatable" : {
"type" : "boolean"
},
"translationKey" : {
"type" : "string"
},
"unique" : {
"type" : "boolean"
},
"writable" : {
"type" : "boolean"
}
}
}
propertyType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "IDENTIFIER", "TEXT", "NUMBER", "INTEGER", "BOOLEAN", "EMAIL", "PASSWORD", "URL", "DATE", "PHONENUMBER", "GEOLOCATION", "COLOR", "CONSTANT", "COMPLEX", "COLLECTION", "REFERENCE" ]
}
schema
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"apiEndpoint" : {
"type" : "string"
},
"authorities" : {
"type" : "array",
"items" : {
"$ref" : "authority.json"
}
},
"collectionName" : {
"type" : "string"
},
"dataReadShareable" : {
"type" : "boolean"
},
"dataShareable" : {
"type" : "boolean"
},
"dataWriteShareable" : {
"type" : "boolean"
},
"defaultPrivate" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"embeddedObject" : {
"type" : "boolean"
},
"favoritable" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"identifiableObject" : {
"type" : "boolean"
},
"implicitPrivateAuthority" : {
"type" : "boolean"
},
"klass" : {
"type" : "string"
},
"metadata" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"nameableObject" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"order" : {
"type" : "integer"
},
"persisted" : {
"type" : "boolean"
},
"plural" : {
"type" : "string"
},
"properties" : {
"type" : "array",
"items" : {
"$ref" : "property.json"
}
},
"references" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeApiEndpoint" : {
"type" : "string"
},
"secondaryMetadata" : {
"type" : "boolean"
},
"shareable" : {
"type" : "boolean"
},
"singular" : {
"type" : "string"
},
"subscribable" : {
"type" : "boolean"
},
"subscribableObject" : {
"type" : "boolean"
},
"translatable" : {
"type" : "boolean"
}
}
}
schemas
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"schemas" : {
"type" : "array",
"items" : {
"$ref" : "schema.json"
}
}
}
}
include_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FALSE", "TRUE", "AUTO" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUTO", "NONE", "IS_EMPTY", "IS_NOT_EMPTY", "SIZE", "MEMBER", "NOT_MEMBER", "IDS", "ID_OBJECTS", "PLUCK" ]
}
userDto
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
}
}
authorities
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "F_TRACKED_ENTITY_INSTANCE_SEARCH_IN_ALL_ORGUNITS", "F_TEI_CASCADE_DELETE", "F_ENROLLMENT_CASCADE_DELETE", "F_EDIT_EXPIRED", "F_IGNORE_TRACKER_REQUIRED_VALUE_VALIDATION", "F_SKIP_DATA_IMPORT_AUDIT", "F_METADATA_EXPORT", "F_USER_VIEW" ]
}
authority
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"type" : {
"$ref" : "authorityType.json"
}
}
}
authorityType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "DATA_CREATE", "CREATE_PUBLIC", "CREATE_PRIVATE", "EXTERNALIZE", "READ", "DATA_READ", "UPDATE", "DELETE" ]
}
recaptchaResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"challenge_ts" : {
"type" : "string"
},
"error-codes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hostname" : {
"type" : "string"
},
"success" : {
"type" : "boolean"
}
}
}
restoreOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RECOVER_PASSWORD_OPTION", "INVITE_WITH_USERNAME_CHOICE", "INVITE_WITH_DEFINED_USERNAME" ]
}
restoreType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RECOVER_PASSWORD", "INVITE" ]
}
access
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"data" : {
"$ref" : "accessData.json"
},
"delete" : {
"type" : "boolean"
},
"externalize" : {
"type" : "boolean"
},
"manage" : {
"type" : "boolean"
},
"read" : {
"type" : "boolean"
},
"update" : {
"type" : "boolean"
},
"write" : {
"type" : "boolean"
}
}
}
accessData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"read" : {
"type" : "boolean"
},
"write" : {
"type" : "boolean"
}
}
}
permission
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "READ", "WRITE", "DATA_READ", "DATA_WRITE" ]
}
apiToken
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "ipAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "IpAllowedList"
}
},
"required" : [ "type" ]
}, {
"$ref" : "refererAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "RefererAllowedList"
}
},
"required" : [ "type" ]
}, {
"$ref" : "methodAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "MethodAllowedList"
}
},
"required" : [ "type" ]
} ]
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"expire" : {
"type" : "integer"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "apiTokenType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"version" : {
"type" : "integer"
}
}
}
apiTokenType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"const" : "PERSONAL_ACCESS_TOKEN"
}
oAuth2Client
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cid" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"grantTypes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"redirectUris" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"secret" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
settingKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UI_LOCALE", "DB_LOCALE", "ANALYSIS_DISPLAY_PROPERTY", "ANALYSIS_DIGIT_GROUP_SEPARATOR", "CURRENT_DOMAIN_TYPE", "TRACKER_DASHBOARD_LAYOUT", "APPLICATION_TITLE", "APPLICATION_INTRO", "APPLICATION_NOTIFICATION", "APPLICATION_FOOTER", "APPLICATION_RIGHT_FOOTER", "FLAG", "FLAG_IMAGE", "START_MODULE", "START_MODULE_ENABLE_LIGHT_WEIGHT", "FACTOR_OF_DEVIATION", "EMAIL_HOST_NAME", "EMAIL_PORT", "EMAIL_USERNAME", "EMAIL_TLS", "EMAIL_SENDER", "EMAIL_PASSWORD", "MIN_PASSWORD_LENGTH", "MAX_PASSWORD_LENGTH", "SMS_CONFIG", "CACHE_STRATEGY", "CACHEABILITY", "ANALYTICS_FINANCIAL_YEAR_START", "PHONE_NUMBER_AREA_CODE", "MULTI_ORGANISATION_UNIT_FORMS", "CONFIGURATION", "ACCOUNT_RECOVERY", "LOCK_MULTIPLE_FAILED_LOGINS", "GOOGLE_ANALYTICS_UA", "CREDENTIALS_EXPIRES", "CREDENTIALS_EXPIRY_ALERT", "ACCOUNT_EXPIRES_IN_DAYS", "ACCOUNT_EXPIRY_ALERT", "SELF_REGISTRATION_NO_RECAPTCHA", "RECAPTCHA_SECRET", "RECAPTCHA_SITE", "CAN_GRANT_OWN_USER_AUTHORITY_GROUPS", "IGNORE_ANALYTICS_APPROVAL_YEAR_THRESHOLD", "ANALYTICS_MAX_LIMIT", "INCLUDE_ZERO_VALUES_IN_ANALYTICS", "SQL_VIEW_MAX_LIMIT", "RESPECT_META_DATA_START_END_DATES_IN_ANALYTICS_TABLE_EXPORT", "SKIP_DATA_TYPE_VALIDATION_IN_ANALYTICS_TABLE_EXPORT", "CUSTOM_LOGIN_PAGE_LOGO", "CUSTOM_TOP_MENU_LOGO", "ANALYTICS_MAINTENANCE_MODE", "DATABASE_SERVER_CPUS", "LAST_SUCCESSFUL_ANALYTICS_TABLES_RUNTIME", "LAST_SUCCESSFUL_LATEST_ANALYTICS_PARTITION_RUNTIME", "LAST_MONITORING_RUN", "LAST_SUCCESSFUL_DATA_VALUE_SYNC", "LAST_SUCCESSFUL_EVENT_DATA_SYNC", "LAST_SUCCESSFUL_COMPLETE_DATA_SET_REGISTRATION_SYNC", "SKIP_SYNCHRONIZATION_FOR_DATA_CHANGED_BEFORE", "LAST_SUCCESSFUL_ANALYTICS_TABLES_UPDATE", "LAST_SUCCESSFUL_LATEST_ANALYTICS_PARTITION_UPDATE", "LAST_SUCCESSFUL_RESOURCE_TABLES_UPDATE", "LAST_SUCCESSFUL_SYSTEM_MONITORING_PUSH", "LAST_SUCCESSFUL_MONITORING", "NEXT_ANALYTICS_TABLE_UPDATE", "HELP_PAGE_LINK", "ACCEPTANCE_REQUIRED_FOR_APPROVAL", "SYSTEM_NOTIFICATIONS_EMAIL", "ANALYSIS_RELATIVE_PERIOD", "REQUIRE_ADD_TO_VIEW", "ALLOW_OBJECT_ASSIGNMENT", "USE_CUSTOM_LOGO_FRONT", "USE_CUSTOM_LOGO_BANNER", "METADATA_REPO_URL", "DATA_IMPORT_STRICT_PERIODS", "DATA_IMPORT_STRICT_DATA_ELEMENTS", "DATA_IMPORT_STRICT_CATEGORY_OPTION_COMBOS", "DATA_IMPORT_STRICT_ORGANISATION_UNITS", "DATA_IMPORT_STRICT_ATTRIBUTE_OPTION_COMBOS", "DATA_IMPORT_REQUIRE_CATEGORY_OPTION_COMBO", "DATA_IMPORT_REQUIRE_ATTRIBUTE_OPTION_COMBO", "CUSTOM_JS", "CUSTOM_CSS", "CALENDAR", "DATE_FORMAT", "STYLE", "REMOTE_INSTANCE_URL", "REMOTE_INSTANCE_USERNAME", "REMOTE_INSTANCE_PASSWORD", "GOOGLE_MAPS_API_KEY", "BING_MAPS_API_KEY", "LAST_SUCCESSFUL_METADATA_SYNC", "METADATAVERSION_ENABLED", "METADATA_FAILED_VERSION", "METADATA_LAST_FAILED_TIME", "LAST_SUCCESSFUL_SCHEDULED_PROGRAM_NOTIFICATIONS", "LAST_SUCCESSFUL_SCHEDULED_DATASET_NOTIFICATIONS", "REMOTE_METADATA_VERSION", "SYSTEM_METADATA_VERSION", "STOP_METADATA_SYNC", "FILE_RESOURCE_RETENTION_STRATEGY", "MAX_REMOTE_SERVER_AVAILABILITY_CHECK_ATTEMPTS", "MAX_SYNC_ATTEMPTS", "DELAY_BETWEEN_REMOTE_SERVER_AVAILABILITY_CHECK_ATTEMPTS", "LAST_SUCCESSFUL_DATA_STATISTICS", "ANALYTICS_HIDE_DAILY_PERIODS", "ANALYTICS_HIDE_WEEKLY_PERIODS", "ANALYTICS_HIDE_BIWEEKLY_PERIODS", "ANALYTICS_HIDE_MONTHLY_PERIODS", "ANALYTICS_HIDE_BIMONTHLY_PERIODS", "GATHER_ANALYTICAL_OBJECT_STATISTICS_IN_DASHBOARD_VIEWS", "COUNT_PASSIVE_DASHBOARD_VIEWS_IN_USAGE_ANALYTICS", "DASHBOARD_CONTEXT_MENU_ITEM_SWITCH_VIEW_TYPE", "DASHBOARD_CONTEXT_MENU_ITEM_OPEN_IN_RELEVANT_APP", "DASHBOARD_CONTEXT_MENU_ITEM_SHOW_INTERPRETATIONS_AND_DETAILS", "DASHBOARD_CONTEXT_MENU_ITEM_VIEW_FULLSCREEN", "RULE_ENGINE_ASSIGN_OVERWRITE", "ANALYTICS_CACHE_PROGRESSIVE_TTL_FACTOR", "ANALYTICS_CACHE_TTL_MODE" ]
}
styleObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"path" : {
"type" : "string"
}
}
}
accessObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
cascadeSharingReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"countUpdatedDashboardItems" : {
"type" : "integer"
},
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"updateObjects" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "idObject_.json"
}
}
}
}
}
cascadeSharingReportBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"countUpdatedDashboardItems(int)" : {
"$ref" : "#"
},
"errorReports(List<ErrorReport>)" : {
"$ref" : "#"
},
"updateObjects(Map<String, Set<IdObject>>)" : {
"$ref" : "#"
}
}
}
idObject_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
completenessMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL_DATAVALUE", "AT_LEAST_ONE_DATAVALUE", "DO_NOT_MARK_COMPLETE" ]
}
sMSCommand
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"codeValueSeparator" : {
"type" : "string"
},
"completenessMethod" : {
"$ref" : "completenessMethod.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"currentPeriodUsedForReporting" : {
"type" : "boolean"
},
"dataset" : {
"$ref" : "dataSet.json"
},
"defaultMessage" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"moreThanOneOrgUnitMessage" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"noUserMessage" : {
"type" : "string"
},
"parserType" : {
"$ref" : "parserType.json"
},
"program" : {
"$ref" : "program.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"receivedMessage" : {
"type" : "string"
},
"separator" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"smsCodes" : {
"type" : "array",
"items" : {
"$ref" : "sMSCode.json"
}
},
"specialCharacters" : {
"type" : "array",
"items" : {
"$ref" : "sMSSpecialCharacter.json"
}
},
"successMessage" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroup" : {
"$ref" : "userGroup.json"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"wrongFormatMessage" : {
"type" : "string"
}
}
}
sMSSpecialCharacter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
sMSCode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"formula" : {
"type" : "string"
},
"optionId" : {
"type" : "integer"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
}
}
}
clickatellGatewayConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"const" : "clickatell"
}
},
"required" : [ "type" ]
}
contentType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APPLICATION_JSON", "APPLICATION_XML", "TEXT_PLAIN", "FORM_URL_ENCODED" ]
}
genericHttpGatewayConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"const" : "http"
}
},
"required" : [ "type" ]
}
incomingSms
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"gatewayid" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"originator" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"receiveddate" : {
"type" : "string",
"format" : "date-time"
},
"sentdate" : {
"type" : "string",
"format" : "date-time"
},
"sharing" : {
"$ref" : "sharing.json"
},
"smsencoding" : {
"$ref" : "smsMessageEncoding.json"
},
"smsstatus" : {
"$ref" : "smsMessageStatus.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
smsMessageEncoding
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ENC7BIT", "ENC8BIT", "ENCUCS2", "ENCCUSTOM" ]
}
smsMessageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCOMING", "PROCESSING", "UNHANDLED", "FAILED", "PROCESSED", "SENT" ]
}
relationshipDir
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FROM", "TO" ]
}
bulkSmsRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
bulkSmsRequestEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"to" : {
"type" : "array",
"items" : {
"$ref" : "bulkSmsRecipient.json"
}
}
}
}
clickatellRequestEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"content" : {
"type" : "string"
},
"to" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
clickatellResponseEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
gatewayResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "SENT", "FAILED", "PENDING", "SERVICE_NOT_AVAILABLE", "ENCODING_FAILURE", "PROCESSING", "QUEUED", "NO_GATEWAY_CONFIGURATION", "NO_DEFAULT_GATEWAY", "AUTHENTICATION_FAILED", "NO_RECIPIENT", "SMS_DISABLED", "SMPP_SESSION_FAILURE", "RESULT_CODE_0", "RESULT_CODE_1", "RESULT_CODE_22", "RESULT_CODE_23", "RESULT_CODE_24", "RESULT_CODE_25", "RESULT_CODE_26", "RESULT_CODE_27", "RESULT_CODE_28", "RESULT_CODE_40", "RESULT_CODE_201", "RESULT_CODE_403", "RESULT_CODE_200", "RESULT_CODE_202", "RESULT_CODE_207", "RESULT_CODE_400", "RESULT_CODE_401", "RESULT_CODE_402", "RESULT_CODE_404", "RESULT_CODE_405", "RESULT_CODE_410", "RESULT_CODE_429", "RESULT_CODE_503", "RESULT_CODE_504" ]
}
outboundSms
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"date" : {
"type" : "string",
"format" : "date-time"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"message" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"recipients" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"sender" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "outboundSmsStatus.json"
},
"subject" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
outboundSmsStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OUTBOUND", "SENT", "ERROR", "PENDING", "SCHEDULED", "DELIVERED", "FAILED" ]
}
submissionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SINGLE", "BATCH" ]
}
parserType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "KEY_VALUE_PARSER", "J2ME_PARSER", "ALERT_PARSER", "UNREGISTERED_PARSER", "TRACKED_ENTITY_REGISTRATION_PARSER", "PROGRAM_STAGE_DATAENTRY_PARSER", "EVENT_REGISTRATION_PARSER" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "USER", "TRACKED_ENTITY_TYPE", "TRACKED_ENTITY_ATTRIBUTE", "PROGRAM", "ORGANISATION_UNIT", "DATA_ELEMENT", "CATEGORY_OPTION_COMBO", "DATASET", "PROGRAM_STAGE", "EVENT", "ENROLLMENT", "TRACKED_ENTITY_INSTANCE", "RELATIONSHIP", "RELATIONSHIP_TYPE" ]
}
smsEnrollmentStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
smsEventStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "VISITED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
submissionType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE_DATASET", "DELETE", "ENROLLMENT", "RELATIONSHIP", "SIMPLE_EVENT", "TRACKER_EVENT" ]
}
valueType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INT", "FLOAT", "DATE", "BOOL", "STRING" ]
}
smsResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "WARN_DVERR", "WARN_DVEMPTY", "WARN_AVEMPTY", "UNKNOWN_ERROR", "HEADER_ERROR", "READ_ERROR", "INVALID_USER", "INVALID_ORGUNIT", "INVALID_PROGRAM", "INVALID_TETYPE", "INVALID_DATASET", "INVALID_PERIOD", "INVALID_AOC", "INVALID_TEI", "INVALID_STAGE", "INVALID_EVENT", "INVALID_RELTYPE", "INVALID_ENROLL", "INVALID_ATTRIB", "USER_NOTIN_OU", "OU_NOTIN_PROGRAM", "OU_NOTIN_DATASET", "ENROLL_FAILED", "DATASET_LOCKED", "MULTI_PROGRAMS", "MULTI_STAGES", "NO_ENROLL", "NULL_ATTRIBVAL", "ENROLL_EXIST" ]
}
sqlView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cacheStrategy" : {
"$ref" : "cacheStrategy.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sqlQuery" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "sqlViewType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
sqlViewType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VIEW", "MATERIALIZED_VIEW", "QUERY" ]
}
systemJob
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FILE_RESOURCE", "DATA_STATISTICS", "VALIDATION_RESULTS_NOTIFICATION", "CREDENTIALS_EXPIRY_ALERT", "ACCOUNT_EXPIRY_ALERT", "DATA_SET_NOTIFICATION", "REMOVE_EXPIRED_OR_USED_RESERVED_VALUES", "LEADER_ELECTION" ]
}
systemInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"buildTime" : {
"type" : "string",
"format" : "date-time"
},
"calendar" : {
"type" : "string"
},
"clusterHostname" : {
"type" : "string"
},
"contextPath" : {
"type" : "string"
},
"cpuCores" : {
"type" : "integer"
},
"databaseInfo" : {
"$ref" : "databaseInfo.json"
},
"dateFormat" : {
"type" : "string"
},
"emailConfigured" : {
"type" : "boolean"
},
"encryption" : {
"type" : "boolean"
},
"environmentVariable" : {
"type" : "string"
},
"externalDirectory" : {
"type" : "string"
},
"fileStoreProvider" : {
"type" : "string"
},
"instanceBaseUrl" : {
"type" : "string"
},
"intervalSinceLastAnalyticsTablePartitionSuccess" : {
"type" : "string"
},
"intervalSinceLastAnalyticsTableSuccess" : {
"type" : "string"
},
"isMetadataVersionEnabled" : {
"type" : "boolean"
},
"jasperReportsVersion" : {
"type" : "string"
},
"javaOpts" : {
"type" : "string"
},
"javaVendor" : {
"type" : "string"
},
"javaVersion" : {
"type" : "string"
},
"lastAnalyticsTablePartitionRuntime" : {
"type" : "string"
},
"lastAnalyticsTablePartitionSuccess" : {
"type" : "string",
"format" : "date-time"
},
"lastAnalyticsTableRuntime" : {
"type" : "string"
},
"lastAnalyticsTableSuccess" : {
"type" : "string",
"format" : "date-time"
},
"lastMetadataVersionSyncAttempt" : {
"type" : "string",
"format" : "date-time"
},
"lastSystemMonitoringSuccess" : {
"type" : "string",
"format" : "date-time"
},
"memoryInfo" : {
"type" : "string"
},
"metadataSyncEnabled" : {
"type" : "boolean"
},
"nodeId" : {
"type" : "string"
},
"osArchitecture" : {
"type" : "string"
},
"osName" : {
"type" : "string"
},
"osVersion" : {
"type" : "string"
},
"readOnlyMode" : {
"type" : "string"
},
"readReplicaCount" : {
"type" : "integer"
},
"redisEnabled" : {
"type" : "boolean"
},
"redisHostname" : {
"type" : "string"
},
"revision" : {
"type" : "string"
},
"serverDate" : {
"type" : "string",
"format" : "date-time"
},
"serverTimeZoneDisplayName" : {
"type" : "string"
},
"serverTimeZoneId" : {
"type" : "string"
},
"systemId" : {
"type" : "string"
},
"systemMetadataVersion" : {
"type" : "string"
},
"systemMonitoringUrl" : {
"type" : "string"
},
"systemName" : {
"type" : "string"
},
"userAgent" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
}
}
databaseInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"databaseVersion" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"spatialSupport" : {
"type" : "boolean"
},
"url" : {
"type" : "string"
},
"user" : {
"type" : "string"
}
}
}
listGrid
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"headerWidth" : {
"type" : "integer"
},
"headers" : {
"type" : "array",
"items" : {
"$ref" : "gridHeader.json"
}
},
"height" : {
"type" : "integer"
},
"metaData" : {
"type" : "object"
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : { }
}
},
"subtitle" : {
"type" : "string"
},
"table" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"width" : {
"type" : "integer"
}
}
}
notification
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"category" : {
"$ref" : "jobType.json"
},
"completed" : {
"type" : "boolean"
},
"id" : {
"type" : "string"
},
"level" : {
"$ref" : "notificationLevel.json"
},
"message" : {
"type" : "string"
},
"time" : {
"type" : "string",
"format" : "date-time"
},
"uid" : {
"type" : "string"
}
}
}
notificationLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OFF", "DEBUG", "INFO", "WARN", "ERROR" ]
}
textPattern
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ownerObject" : {
"$ref" : "objects.json"
},
"ownerUid" : {
"type" : "string"
},
"segments" : {
"type" : "array",
"items" : {
"$ref" : "textPatternSegment.json"
}
}
}
}
textPatternMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "RANDOM", "SEQUENTIAL", "ORG_UNIT_CODE", "CURRENT_DATE" ]
}
textPatternSegment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"method" : {
"$ref" : "textPatternMethod.json"
},
"parameter" : {
"type" : "string"
}
}
}
trackedEntityAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"confidential" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInListNoProgram" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayOnVisitSchedule" : {
"type" : "boolean"
},
"displayShortName" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldMask" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"generated" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"inherit" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetValue" : {
"type" : "boolean"
},
"orgunitScope" : {
"type" : "boolean"
},
"pattern" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipSynchronization" : {
"type" : "boolean"
},
"sortOrderInListNoProgram" : {
"type" : "integer"
},
"sortOrderInVisitSchedule" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"unique" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
trackedEntityAttributeDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
}
}
}
trackedEntityDataElementDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElement" : {
"$ref" : "dataElement.json"
},
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"programStage" : {
"$ref" : "programStage.json"
}
}
}
trackedEntityInstance_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"inactive" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"potentialDuplicate" : {
"type" : "boolean"
},
"programInstances" : {
"type" : "array",
"items" : {
"$ref" : "programInstance.json"
}
},
"programOwners" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramOwner.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityAttributeValues" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeValue.json"
}
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
orderColumn
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKEDENTITY", "CREATED", "CREATED_AT", "CREATED_AT_CLIENT", "UPDATED_AT", "UPDATED_AT_CLIENT", "ENROLLED_AT", "INACTIVE" ]
}
trackedEntityProgramIndicatorDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
}
}
}
trackedEntityProgramOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
trackedEntityType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowAuditLog" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"maxTeiCountToReturn" : {
"type" : "integer"
},
"minAttributesRequiredToSearch" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityTypeAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityTypeAttribute.json"
}
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
trackedEntityTypeAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayInList" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"searchable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
trackedEntityAttributeValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"value" : {
"type" : "string"
}
}
}
trackedEntityAttributeValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"auditType" : {
"$ref" : "auditType_.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"modifiedBy" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"value" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"commentText" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"creator" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
trackedEntityDataValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"auditType" : {
"$ref" : "auditType_.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"modifiedBy" : {
"type" : "string"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"value" : {
"type" : "string"
}
}
}
eventFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUserMode" : {
"$ref" : "assignedUserSelectionMode.json"
},
"assignedUsers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"eventCreatedPeriod" : {
"$ref" : "filterPeriod.json"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"programStage" : {
"type" : "string"
}
}
}
filterPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"periodFrom" : {
"type" : "integer"
},
"periodTo" : {
"type" : "integer"
}
}
}
trackedEntityInstanceFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"enrollmentCreatedPeriod" : {
"$ref" : "filterPeriod.json"
},
"enrollmentStatus" : {
"$ref" : "programStatus.json"
},
"eventFilters" : {
"type" : "array",
"items" : {
"$ref" : "eventFilter.json"
}
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followup" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
translation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"locale" : {
"type" : "string"
},
"property" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
translationProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORT_NAME", "DESCRIPTION", "FORM_NAME", "NUMERATOR_DESCRIPTION", "DENOMINATOR_DESCRIPTION", "RELATIONSHIP_FROM_TO_NAME", "RELATIONSHIP_TO_FROM_NAME", "INSTRUCTION", "INCIDENT_DATE_LABEL", "ENROLLMENT_DATE_LABEL", "EXECUTION_DATE_LABEL", "DUE_DATE_LABEL", "CONTENT" ]
}
passwordValidationError
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PASSWORD_IS_MANDATORY", "PASSWORD_TOO_LONG_TOO_SHORT", "PASSWORD_MUST_HAVE_DIGIT", "PASSWORD_MUST_HAVE_UPPER", "PASSWORD_MUST_HAVE_SPECIAL", "PASSWORD_CONTAINS_RESERVED_WORD", "PASSWORD_CONTAINS_NAME_OR_EMAIL", "PASSWORD_ALREADY_USED_BEFORE" ]
}
user
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"avatar" : {
"$ref" : "fileResource.json"
},
"birthday" : {
"type" : "string",
"format" : "date-time"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "#"
},
"dataViewMaxOrganisationUnitLevel" : {
"type" : "integer"
},
"dataViewOrganisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"displayName" : {
"type" : "string"
},
"education" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"employer" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"facebookMessenger" : {
"type" : "string"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"firstName" : {
"type" : "string"
},
"gender" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interests" : {
"type" : "string"
},
"introduction" : {
"type" : "string"
},
"jobTitle" : {
"type" : "string"
},
"languages" : {
"type" : "string"
},
"lastCheckedInterpretations" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "#"
},
"name" : {
"type" : "string"
},
"nationality" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"phoneNumber" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skype" : {
"type" : "string"
},
"surname" : {
"type" : "string"
},
"teiSearchOrganisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"telegram" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"twitter" : {
"type" : "string"
},
"user" : {
"$ref" : "#"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userCredentials" : {
"$ref" : "userCredentials.json"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"welcomeMessage" : {
"type" : "string"
},
"whatsApp" : {
"type" : "string"
}
}
}
userAccess
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"userUid" : {
"type" : "string"
},
"displayName()" : {
"type" : "string"
}
}
}
userAuthorityGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
userCredentials
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accountExpiry" : {
"type" : "string",
"format" : "date-time"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"catDimensionConstraints" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"code" : {
"type" : "string"
},
"cogsDimensionConstraints" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"disabled" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"externalAuth" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"invitation" : {
"type" : "boolean"
},
"lastLogin" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"ldapId" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"openId" : {
"type" : "string"
},
"password" : {
"type" : "string",
"writeOnly" : true
},
"passwordLastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"publicAccess" : {
"type" : "string"
},
"selfRegistered" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"twoFA" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userInfo" : {
"$ref" : "user.json"
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"username" : {
"type" : "string"
}
}
}
userGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"managedByGroups" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"managedGroups" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
userGroupAccess
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"userGroupUid" : {
"type" : "string"
},
"displayName()" : {
"type" : "string"
}
}
}
userInvitationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "ALL", "EXPIRED" ]
}
userSettingKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "STYLE", "MESSAGE_EMAIL_NOTIFICATION", "MESSAGE_SMS_NOTIFICATION", "UI_LOCALE", "DB_LOCALE", "ANALYSIS_DISPLAY_PROPERTY", "TRACKER_DASHBOARD_LAYOUT" ]
}
users
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
sharing
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"external" : {
"type" : "boolean"
},
"owner" : {
"type" : "string"
},
"public" : {
"type" : "string"
},
"userGroups" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "userGroupAccess_.json"
}
},
"users" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "userAccess_.json"
}
}
}
}
sharingBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"external(boolean)" : {
"$ref" : "#"
},
"owner(String)" : {
"$ref" : "#"
},
"public(String)" : {
"$ref" : "#"
},
"userGroups(Map<String, UserGroupAccess>)" : {
"$ref" : "#"
},
"users(Map<String, UserAccess>)" : {
"$ref" : "#"
}
}
}
userAccess_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
userGroupAccess_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
userKeyJsonValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "string"
}
}
}
importance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "HIGH", "MEDIUM", "LOW" ]
}
validationResult
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dayInPeriod" : {
"type" : "integer"
},
"id" : {
"type" : "integer"
},
"leftsideValue" : {
"type" : "number"
},
"notificationSent" : {
"type" : "boolean"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"rightsideValue" : {
"type" : "number"
},
"validationRule" : {
"$ref" : "validationRule.json"
}
}
}
validationRule
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInstruction" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"importance" : {
"$ref" : "importance.json"
},
"instruction" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leftSide" : {
"$ref" : "expression.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "validationNotificationTemplate.json"
}
},
"operator" : {
"$ref" : "operator.json"
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"rightSide" : {
"$ref" : "expression.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipFormValidation" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"$ref" : "validationRuleGroup.json"
}
}
}
}
validationRuleGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
validationRunType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INTERACTIVE", "SCHEDULED" ]
}
validationSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"commentRequiredViolations" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"validationRuleViolations" : {
"type" : "array",
"items" : {
"$ref" : "validationResult.json"
}
}
}
}
validationNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"sendStrategy" : {
"$ref" : "sendStrategy.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
validationRuleTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RULE_NAME", "DESCRIPTION", "OPERATOR", "IMPORTANCE", "LEFT_SIDE_DESCRIPTION", "RIGHT_SIDE_DESCRIPTION", "LEFT_SIDE_VALUE", "RIGHT_SIDE_VALUE", "ORG_UNIT_NAME", "PERIOD", "CURRENT_DATE" ]
}
validationRuleTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RULE_NAME", "DESCRIPTION", "OPERATOR", "IMPORTANCE", "LEFT_SIDE_DESCRIPTION", "RIGHT_SIDE_DESCRIPTION", "LEFT_SIDE_VALUE", "RIGHT_SIDE_VALUE", "ORG_UNIT_NAME", "PERIOD", "CURRENT_DATE" ]
}
axis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"axis" : {
"type" : "integer"
},
"dimensionalItem" : {
"type" : "string"
}
}
}
axisType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DOMAIN", "RANGE" ]
}
axisV2
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"baseLine" : {
"$ref" : "line.json"
},
"decimals" : {
"type" : "integer"
},
"index" : {
"type" : "integer"
},
"label" : {
"$ref" : "styledObject.json"
},
"maxValue" : {
"type" : "integer"
},
"minValue" : {
"type" : "integer"
},
"steps" : {
"type" : "integer"
},
"targetLine" : {
"$ref" : "line.json"
},
"title" : {
"$ref" : "styledObject.json"
},
"type" : {
"$ref" : "axisType.json"
}
}
}
legendDefinitions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"set" : {
"$ref" : "legendSet.json"
},
"showKey" : {
"type" : "boolean"
},
"strategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"style" : {
"$ref" : "legendDisplayStyle.json"
}
}
}
line
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"title" : {
"$ref" : "styledObject.json"
},
"value" : {
"type" : "integer"
}
}
}
normalizedOutlierMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"const" : "Y_RESIDUALS_LINEAR"
}
outlierAnalysis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"extremeLines" : {
"$ref" : "outlierLine.json"
},
"normalizationMethod" : {
"$ref" : "normalizedOutlierMethod.json"
},
"outlierMethod" : {
"$ref" : "outlierMethod.json"
},
"thresholdFactor" : {
"type" : "number"
}
}
}
outlierLine
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"value" : {
"type" : "number"
}
}
}
outlierMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "IQR", "STANDARD_Z_SCORE", "MODIFIED_Z_SCORE" ]
}
reportingParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"grandParentOrganisationUnit" : {
"type" : "boolean"
},
"organisationUnit" : {
"type" : "boolean"
},
"parentOrganisationUnit" : {
"type" : "boolean"
},
"reportingPeriod" : {
"type" : "boolean"
}
}
}
series
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"axis" : {
"type" : "integer"
},
"dimensionItem" : {
"type" : "string"
},
"type" : {
"$ref" : "visualizationType.json"
}
}
}
seriesKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"hidden" : {
"type" : "boolean"
},
"label" : {
"$ref" : "styledObject.json"
}
}
}
simpleVisualizationView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
styledObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fontStyle" : {
"$ref" : "fontStyle.json"
},
"text" : {
"type" : "string"
},
"textMode" : {
"$ref" : "textMode.json"
}
}
}
textMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUTO", "CUSTOM" ]
}
visualization
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"axes" : {
"type" : "array",
"items" : {
"$ref" : "axisV2.json"
}
},
"baseLineLabel" : {
"type" : "string",
"readOnly" : true
},
"baseLineValue" : {
"type" : "number",
"readOnly" : true
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"colSubTotals" : {
"type" : "boolean"
},
"colTotals" : {
"type" : "boolean"
},
"colorSet" : {
"type" : "string"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDensity" : {
"$ref" : "displayDensity.json"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string",
"readOnly" : true
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"fixColumnHeaders" : {
"type" : "boolean"
},
"fixRowHeaders" : {
"type" : "boolean"
},
"fontSize" : {
"$ref" : "fontSize.json"
},
"fontStyle" : {
"$ref" : "visualizationFontStyle.json"
},
"formName" : {
"type" : "string"
},
"hideEmptyColumns" : {
"type" : "boolean"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideEmptyRows" : {
"type" : "boolean"
},
"hideLegend" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legend" : {
"$ref" : "legendDefinitions.json"
},
"measureCriteria" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"numberType" : {
"$ref" : "numberType.json"
},
"optionalAxes" : {
"type" : "array",
"items" : {
"$ref" : "axis.json"
}
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outlierAnalysis" : {
"$ref" : "outlierAnalysis.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer",
"readOnly" : true
},
"rangeAxisLabel" : {
"type" : "string",
"readOnly" : true
},
"rangeAxisMaxValue" : {
"type" : "number",
"readOnly" : true
},
"rangeAxisMinValue" : {
"type" : "number",
"readOnly" : true
},
"rangeAxisSteps" : {
"type" : "integer",
"readOnly" : true
},
"regression" : {
"type" : "boolean"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"reportingParams" : {
"$ref" : "reportingParams.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rowSubTotals" : {
"type" : "boolean"
},
"rowTotals" : {
"type" : "boolean"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"series" : {
"type" : "array",
"items" : {
"$ref" : "series.json"
}
},
"seriesKey" : {
"$ref" : "seriesKey.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"showDimensionLabels" : {
"type" : "boolean"
},
"showHierarchy" : {
"type" : "boolean"
},
"skipRounding" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string",
"readOnly" : true
},
"targetLineValue" : {
"type" : "number",
"readOnly" : true
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"visualizationPeriodName" : {
"type" : "string"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
visualizationFontStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"baseLineLabel" : {
"$ref" : "fontStyle.json"
},
"categoryAxisLabel" : {
"$ref" : "fontStyle.json"
},
"horizontalAxisTitle" : {
"$ref" : "fontStyle.json"
},
"legend" : {
"$ref" : "fontStyle.json"
},
"seriesAxisLabel" : {
"$ref" : "fontStyle.json"
},
"targetLineLabel" : {
"$ref" : "fontStyle.json"
},
"verticalAxisTitle" : {
"$ref" : "fontStyle.json"
},
"visualizationSubtitle" : {
"$ref" : "fontStyle.json"
},
"visualizationTitle" : {
"$ref" : "fontStyle.json"
}
}
}
visualizationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COLUMN", "STACKED_COLUMN", "BAR", "STACKED_BAR", "LINE", "AREA", "STACKED_AREA", "PIE", "RADAR", "GAUGE", "YEAR_OVER_YEAR_LINE", "YEAR_OVER_YEAR_COLUMN", "SINGLE_VALUE", "PIVOT_TABLE", "SCATTER", "BUBBLE" ]
}
sortDirection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC", "IASC", "IDESC" ]
}
jsonNodeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OBJECT", "ARRAY", "STRING", "NUMBER", "BOOLEAN", "NULL" ]
}
geometry
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionItemKeywords
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
forwardingMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
abstractMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
hashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
linkedHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
aggregationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUM", "AVERAGE", "AVERAGE_SUM_ORG_UNIT", "LAST", "LAST_AVERAGE_ORG_UNIT", "LAST_IN_PERIOD", "LAST_IN_PERIOD_AVERAGE_ORG_UNIT", "FIRST", "FIRST_AVERAGE_ORG_UNIT", "COUNT", "STDDEV", "VARIANCE", "MIN", "MAX", "NONE", "CUSTOM", "DEFAULT" ]
}
analyticsCacheTtlMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FIXED", "PROGRESSIVE" ]
}
analyticsFavoriteType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION", "REPORT_TABLE", "CHART", "MAP", "EVENT_REPORT", "EVENT_CHART", "DATASET_REPORT" ]
}
analyticsFinancialYearStartKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FINANCIAL_YEAR_APRIL", "FINANCIAL_YEAR_JULY", "FINANCIAL_YEAR_OCTOBER" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ITEMS", "DIMENSIONS", "PAGER", "ORG_UNIT_HIERARCHY", "ORG_UNIT_NAME_HIERARCHY", "ORG_UNIT_ANCESTORS" ]
}
analyticsTableHook
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"analyticsTableType" : {
"$ref" : "analyticsTableType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"phase" : {
"$ref" : "analyticsTablePhase.json"
},
"publicAccess" : {
"type" : "string"
},
"resourceTableType" : {
"$ref" : "resourceTableType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sql" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
analyticsTablePhase
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RESOURCE_TABLE_POPULATED", "ANALYTICS_TABLE_POPULATED" ]
}
analyticsTableType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_VALUE", "COMPLETENESS", "COMPLETENESS_TARGET", "ORG_UNIT_TARGET", "EVENT", "ENROLLMENT", "VALIDATION_RESULT" ]
}
dataType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NUMERIC", "BOOLEAN", "TEXT" ]
}
eventDataType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATED_VALUES", "EVENTS" ]
}
eventOutputType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT", "TRACKED_ENTITY_INSTANCE" ]
}
numberType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VALUE", "ROW_PERCENTAGE", "COLUMN_PERCENTAGE" ]
}
sortOrder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC" ]
}
userOrgUnitType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_CAPTURE", "DATA_OUTPUT", "TEI_SEARCH" ]
}
cacheType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "IN_MEMORY", "REDIS" ]
}
app
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activities" : {
"$ref" : "appActivities.json"
},
"appState" : {
"$ref" : "appStatus.json"
},
"appStorageSource" : {
"$ref" : "appStorageSource.json"
},
"appType" : {
"$ref" : "appType.json"
},
"app_hub_id" : {
"type" : "string"
},
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"baseUrl" : {
"type" : "string"
},
"bundled" : {
"type" : "boolean"
},
"core_app" : {
"type" : "boolean"
},
"default_locale" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"developer" : {
"$ref" : "appDeveloper.json"
},
"folderName" : {
"type" : "string"
},
"icons" : {
"$ref" : "appIcons.json"
},
"installs_allowed_from" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"key" : {
"type" : "string"
},
"launchUrl" : {
"type" : "string"
},
"launch_path" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"settings" : {
"$ref" : "appSettings.json"
},
"short_name" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
}
}
appActivities
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dhis" : {
"$ref" : "appDhis.json"
}
}
}
appDeveloper
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"company" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"url" : {
"type" : "string"
}
}
}
appDhis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
}
}
}
appIcons
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"128" : {
"type" : "string"
},
"16" : {
"type" : "string"
},
"48" : {
"type" : "string"
}
}
}
appSettings
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dashboardWidget" : {
"$ref" : "dashboardWidgetAppSettings.json"
}
}
}
appStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "INVALID_BUNDLED_APP_OVERRIDE", "INVALID_CORE_APP", "NAMESPACE_TAKEN", "INVALID_ZIP_FORMAT", "MISSING_MANIFEST", "INVALID_MANIFEST_JSON", "INSTALLATION_FAILED", "NOT_FOUND", "MISSING_SYSTEM_BASE_URL", "APPROVED", "PENDING", "NOT_APPROVED", "DELETION_IN_PROGRESS" ]
}
appStorageSource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LOCAL", "JCLOUDS" ]
}
appType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APP", "RESOURCE", "DASHBOARD_WIDGET", "TRACKER_DASHBOARD_WIDGET" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"hideTitle" : {
"type" : "boolean"
}
}
}
messageType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUDIT", "TRACKER_JOB", "TRACKER_SIDE_EFFECT" ]
}
serializableMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"messageType" : {
"$ref" : "messageType.json"
}
}
}
audit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"$ref" : "auditAttributes.json"
},
"auditScope" : {
"$ref" : "auditScope.json"
},
"auditType" : {
"$ref" : "auditType.json"
},
"code" : {
"type" : "string"
},
"createdAt" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"data" : { },
"klass" : {
"type" : "string"
},
"messageType" : {
"$ref" : "messageType.json"
},
"uid" : {
"type" : "string"
}
}
}
auditBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes(AuditAttributes)" : {
"$ref" : "#"
},
"auditScope(AuditScope)" : {
"$ref" : "#"
},
"auditType(AuditType)" : {
"$ref" : "#"
},
"code(String)" : {
"$ref" : "#"
},
"createdAt(LocalDateTime)" : {
"$ref" : "#"
},
"createdBy(String)" : {
"$ref" : "#"
},
"data(Object)" : {
"$ref" : "#"
},
"klass(String)" : {
"$ref" : "#"
},
"uid(String)" : {
"$ref" : "#"
}
}
}
artemisConfigData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"embedded" : {
"$ref" : "artemisEmbeddedConfig.json"
},
"host" : {
"type" : "string"
},
"mode" : {
"$ref" : "artemisMode.json"
},
"port" : {
"type" : "integer"
},
"sendAsync" : {
"type" : "boolean"
}
}
}
artemisEmbeddedConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistence" : {
"type" : "boolean"
},
"security" : {
"type" : "boolean"
}
}
}
artemisMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EMBEDDED", "NATIVE" ]
}
attribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryAttribute" : {
"type" : "boolean"
},
"categoryOptionAttribute" : {
"type" : "boolean"
},
"categoryOptionComboAttribute" : {
"type" : "boolean"
},
"categoryOptionGroupAttribute" : {
"type" : "boolean"
},
"categoryOptionGroupSetAttribute" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"constantAttribute" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementAttribute" : {
"type" : "boolean"
},
"dataElementGroupAttribute" : {
"type" : "boolean"
},
"dataElementGroupSetAttribute" : {
"type" : "boolean"
},
"dataSetAttribute" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"documentAttribute" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorAttribute" : {
"type" : "boolean"
},
"indicatorGroupAttribute" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSetAttribute" : {
"type" : "boolean"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"optionAttribute" : {
"type" : "boolean"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetAttribute" : {
"type" : "boolean"
},
"organisationUnitAttribute" : {
"type" : "boolean"
},
"organisationUnitGroupAttribute" : {
"type" : "boolean"
},
"organisationUnitGroupSetAttribute" : {
"type" : "boolean"
},
"programAttribute" : {
"type" : "boolean"
},
"programIndicatorAttribute" : {
"type" : "boolean"
},
"programStageAttribute" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"sectionAttribute" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"sqlViewAttribute" : {
"type" : "boolean"
},
"trackedEntityAttributeAttribute" : {
"type" : "boolean"
},
"trackedEntityTypeAttribute" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"unique" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userAttribute" : {
"type" : "boolean"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userGroupAttribute" : {
"type" : "boolean"
},
"validationRuleAttribute" : {
"type" : "boolean"
},
"validationRuleGroupAttribute" : {
"type" : "boolean"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
attributeValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"$ref" : "attribute.json"
},
"value" : {
"type" : "string"
}
}
}
audit_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"$ref" : "auditAttributes.json"
},
"auditScope" : {
"$ref" : "auditScope.json"
},
"auditType" : {
"$ref" : "auditType.json"
},
"code" : {
"type" : "string"
},
"createdAt" : {
"type" : "string"
},
"createdBy" : {
"type" : "string"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
auditBuilder_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes(AuditAttributes)" : {
"$ref" : "#"
},
"auditScope(AuditScope)" : {
"$ref" : "#"
},
"auditType(AuditType)" : {
"$ref" : "#"
},
"code(String)" : {
"$ref" : "#"
},
"createdAt(LocalDateTime)" : {
"$ref" : "#"
},
"createdBy(String)" : {
"$ref" : "#"
},
"klass(String)" : {
"$ref" : "#"
},
"uid(String)" : {
"$ref" : "#"
}
}
}
auditAttributes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
auditScope
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "METADATA", "AGGREGATE", "TRACKER" ]
}
auditType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "READ", "UPDATE", "DELETE", "SEARCH", "SECURITY" ]
}
trackedEntityInstanceAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"accessedBy" : {
"type" : "string"
},
"auditType" : {
"$ref" : "auditType_.json"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"trackedEntityInstance" : {
"type" : "string"
}
}
}
cacheInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"burden" : {
"$ref" : "cacheBurdenInfo.json"
},
"cap" : {
"$ref" : "cacheCapInfo.json"
},
"regions" : {
"type" : "array",
"items" : {
"$ref" : "cacheGroupInfo.json"
}
},
"total" : {
"$ref" : "cacheGroupInfo.json"
}
}
}
cacheBurdenInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"averageEntrySize" : {
"type" : "integer"
},
"averageEntrySizeHumanReadable" : {
"type" : "string"
},
"entries" : {
"type" : "integer"
},
"size" : {
"type" : "integer"
},
"sizeHumanReadable" : {
"type" : "string"
},
"threshold" : {
"type" : "number"
}
}
}
cacheCapInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"capPercentage" : {
"type" : "integer"
},
"hardCapPercentage" : {
"type" : "integer"
},
"softCapPercentage" : {
"type" : "integer"
}
}
}
cacheGroupInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"averageEntrySize" : {
"type" : "integer"
},
"averageEntrySizeHumanReadable" : {
"type" : "string"
},
"burden" : {
"type" : "number"
},
"entries" : {
"type" : "integer"
},
"highBurdenEntries" : {
"type" : "integer"
},
"hits" : {
"type" : "integer"
},
"hitsMissesRatio" : {
"type" : "number"
},
"misses" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"size" : {
"type" : "integer"
},
"sizeHumanReadable" : {
"type" : "string"
}
}
}
cacheType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "IN_MEMORY", "REDIS" ]
}
region
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "analyticsResponse", "defaultObjectCache", "isDataApproved", "allConstantsCache", "inUserOuHierarchy", "isUserViewOuHierHierarchy", "inUserSearchOuHierarchy", "userCaptureOuCountThreshold", "periodIdCache", "userAccountRecoverAttempt", "userFailedLoginAttempt", "programOwner", "programTempOwner", "userIdCache", "currentUserGroupInfoCache", "userSetting", "attrOptionComboIdCache", "systemSetting", "googleAccessToken", "dataItemsPagination", "metadataAttributes", "canDataWriteCocCache", "analyticsSql", "dataElementCache", "propertyTransformerCache", "programHasRulesCache", "programRuleVariablesCache", "userGroupNameCache", "userDisplayNameCache", "programWebHookNotificationTemplateCache", "programStageWebHookNotificationTemplateCache", "pgmOrgUnitAssocCache", "catOptOrgUnitAssocCache", "apiTokensCache" ]
}
dateIntervalType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ISO8601_YEAR", "ISO8601_MONTH", "ISO8601_WEEK", "ISO8601_DAY" ]
}
dateUnitType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "WEEKLY_WEDNESDAY", "WEEKLY_THURSDAY", "WEEKLY_SATURDAY", "WEEKLY_SUNDAY", "BI_WEEKLY", "MONTHLY", "BI_MONTHLY", "QUARTERLY", "SIX_MONTHLY", "SIX_MONTHLY_APRIL", "SIX_MONTHLY_NOVEMBER", "YEARLY", "FINANCIAL_APRIL", "FINANCIAL_JULY", "FINANCIAL_OCTOBER", "FINANCIAL_NOVEMBER" ]
}
category
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryCombo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"default" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skipTotal" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"category" : {
"$ref" : "category.json"
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
}
}
}
categoryOption
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"default" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionCombo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"ignoreApproval" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
categoryOptionGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryOptionGroupSet" : {
"$ref" : "categoryOptionGroupSet.json"
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
}
}
}
accessLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OPEN", "AUDITED", "PROTECTED", "CLOSED" ]
}
analyticsType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE", "EVENT" ]
}
assignedUserSelectionMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CURRENT", "PROVIDED", "NONE", "ANY" ]
}
auditType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "UPDATE", "DELETE", "READ", "SEARCH" ]
}
baseAnalyticalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
}
}
}
baseDataDimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseDimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseDimensionalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseIdentifiableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
baseLinkableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
}
}
}
baseNameableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
compression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "GZIP", "ZIP" ]
}
dataDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataDimensionItemType" : {
"$ref" : "dataDimensionItemType.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"dataElementOperand" : {
"$ref" : "dataElementOperand.json"
},
"indicator" : {
"$ref" : "indicator.json"
},
"programAttribute" : {
"$ref" : "programTrackedEntityAttributeDimensionItem.json"
},
"programDataElement" : {
"$ref" : "programDataElementDimensionItem.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
},
"reportingRate" : {
"$ref" : "reportingRate.json"
}
}
}
dataDimensionItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR", "DATA_ELEMENT", "DATA_ELEMENT_OPERAND", "REPORTING_RATE", "PROGRAM_INDICATOR", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "VALIDATION_RULE" ]
}
dataDimensionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DISAGGREGATION", "ATTRIBUTE" ]
}
deliveryChannel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SMS", "EMAIL", "HTTP" ]
}
dhisApiVersion
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "V28", "V29", "V30", "V31", "V32", "V33", "V34", "V35", "V36", "V37", "V38", "DEFAULT" ]
}
digitGroupSeparator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMMA", "SPACE", "NONE" ]
}
dimensionItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT", "DATA_ELEMENT_OPERAND", "INDICATOR", "REPORTING_RATE", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "PROGRAM_INDICATOR", "PERIOD", "ORGANISATION_UNIT", "CATEGORY_OPTION", "OPTION_GROUP", "DATA_ELEMENT_GROUP", "ORGANISATION_UNIT_GROUP", "CATEGORY_OPTION_GROUP" ]
}
dimensionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_X", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE", "PROGRAM_INDICATOR", "DATA_COLLAPSED", "CATEGORY_OPTION_COMBO", "ATTRIBUTE_OPTION_COMBO", "PERIOD", "ORGANISATION_UNIT", "CATEGORY_OPTION_GROUP_SET", "DATA_ELEMENT_GROUP_SET", "ORGANISATION_UNIT_GROUP_SET", "ORGANISATION_UNIT_GROUP", "CATEGORY", "OPTION_GROUP_SET", "VALIDATION_RULE", "STATIC", "ORGANISATION_UNIT_LEVEL" ]
}
displayDensity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMFORTABLE", "NORMAL", "COMPACT", "NONE" ]
}
displayProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORTNAME" ]
}
fallbackCoordinateFieldType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OU_GEOMETRY", "PSI_GEOMETRY" ]
}
fileTypeValueOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"type" : "object",
"properties" : {
"allowedContentTypes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"maxFileSize" : {
"type" : "integer"
},
"version" : {
"type" : "integer"
}
}
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
}
font
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ARIAL", "SANS_SERIF", "VERDANA", "ROBOTO" ]
}
fontSize
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LARGE", "NORMAL", "SMALL" ]
}
fontStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"bold" : {
"type" : "boolean"
},
"font" : {
"$ref" : "font.json"
},
"fontSize" : {
"type" : "integer"
},
"italic" : {
"type" : "boolean"
},
"textAlign" : {
"$ref" : "textAlign.json"
},
"textColor" : {
"type" : "string"
},
"underline" : {
"type" : "boolean"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"column" : {
"type" : "string"
},
"hidden" : {
"type" : "boolean"
},
"legendSet" : {
"type" : "string"
},
"meta" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"optionSet" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
hideEmptyItemStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "BEFORE_FIRST", "AFTER_LAST", "BEFORE_FIRST_AFTER_LAST", "ALL" ]
}
idSchemes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
identifiableObjects
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"additions" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
},
"deletions" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
},
"identifiableObjects" : {
"type" : "array",
"items" : {
"$ref" : "baseIdentifiableObject.json"
}
}
}
}
identifiableProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "UID", "UUID", "NAME", "CODE", "ATTRIBUTE" ]
}
listMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : { }
}
}
listMapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "listMap.json"
}
}
map4
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "mapMapMap.json"
}
}
mapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
mapMapMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"$ref" : "mapMap.json"
}
}
mergeMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MERGE_ALWAYS", "MERGE_IF_NOT_NULL", "MERGE", "REPLACE", "NONE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"code" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"indicatorType" : {
"$ref" : "indicatorType.json"
},
"legendSet" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"totalAggregationType" : {
"$ref" : "totalAggregationType.json"
},
"uid" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
nameableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
notificationTemplateObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
objectStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"color" : {
"type" : "string"
},
"icon" : {
"type" : "string"
}
}
}
objects
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CONSTANT", "DATAELEMENT", "EXTENDEDDATAELEMENT", "DATAELEMENTGROUP", "DATAELEMENTGROUPSET", "INDICATORTYPE", "INDICATOR", "INDICATORGROUP", "INDICATORGROUPSET", "DATASET", "ORGANISATIONUNIT", "ORGANISATIONUNITGROUP", "ORGANISATIONUNITGROUPSET", "ORGANISATIONUNITLEVEL", "VALIDATIONRULE", "PERIOD", "DATAVALUE", "USER", "USERGROUP", "VISUALIZATION", "REPORT", "MAP", "DASHBOARD", "PROGRAM", "PROGRAMSTAGEINSTANCE", "PROGRAMINSTANCE", "TRACKEDENTITYINSTANCE", "TRACKEDENTITYATTRIBUTE" ]
}
organisationUnitSelectionMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SELECTED", "CHILDREN", "DESCENDANTS", "ACCESSIBLE", "CAPTURE", "ALL" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"nextPage" : {
"type" : "string"
},
"page" : {
"type" : "integer"
},
"pageCount" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"prevPage" : {
"type" : "string"
},
"total" : {
"type" : "integer"
}
}
}
queryOperator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EQ", "GT", "GE", "LT", "LE", "NE", "LIKE", "IN" ]
}
regressionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "LINEAR", "POLYNOMIAL", "LOESS" ]
}
reportingRate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"metric" : {
"$ref" : "reportingRateMetric.json"
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
reportingRateMetric
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "REPORTING_RATE", "REPORTING_RATE_ON_TIME", "ACTUAL_REPORTS", "ACTUAL_REPORTS_ON_TIME", "EXPECTED_REPORTS" ]
}
setMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : { }
}
}
softDeletableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
sortProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORT_NAME" ]
}
textAlign
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LEFT", "CENTER", "RIGHT" ]
}
totalAggregationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUM", "AVERAGE" ]
}
translatableObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
}
}
}
valueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "LONG_TEXT", "LETTER", "PHONE_NUMBER", "EMAIL", "BOOLEAN", "TRUE_ONLY", "DATE", "DATETIME", "TIME", "NUMBER", "UNIT_INTERVAL", "PERCENTAGE", "INTEGER", "INTEGER_POSITIVE", "INTEGER_NEGATIVE", "INTEGER_ZERO_OR_POSITIVE", "TRACKER_ASSOCIATE", "USERNAME", "COORDINATE", "ORGANISATION_UNIT", "AGE", "URL", "FILE_RESOURCE", "IMAGE" ]
}
valueTypeOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"$ref" : "fileTypeValueOptions.json"
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
}
localPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
cacheStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NO_CACHE", "CACHE_1_MINUTE", "CACHE_5_MINUTES", "CACHE_10_MINUTES", "CACHE_15_MINUTES", "CACHE_30_MINUTES", "CACHE_1_HOUR", "CACHE_6AM_TOMORROW", "CACHE_TWO_WEEKS", "RESPECT_SYSTEM_SETTING" ]
}
cacheability
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PUBLIC", "PRIVATE" ]
}
appendingHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
cachingMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
mimicingHashMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
jsonPatch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"operations" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "addOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "add"
}
},
"required" : [ "op" ]
}, {
"$ref" : "removeOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "remove"
}
},
"required" : [ "op" ]
}, {
"$ref" : "replaceOperation.json",
"type" : "object",
"properties" : {
"op" : {
"const" : "replace"
}
},
"required" : [ "op" ]
} ]
}
}
}
}
weekday
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
}
configuration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"corsWhitelist" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"facilityOrgUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"facilityOrgUnitLevel" : {
"$ref" : "organisationUnitLevel.json"
},
"feedbackRecipients" : {
"$ref" : "userGroup.json"
},
"infrastructuralDataElements" : {
"$ref" : "dataElementGroup.json"
},
"infrastructuralIndicators" : {
"$ref" : "indicatorGroup.json"
},
"infrastructuralPeriodType" : {
"$ref" : "periodType.json"
},
"offlineOrganisationUnitLevel" : {
"$ref" : "organisationUnitLevel.json"
},
"selfRegistrationOrgUnit" : {
"$ref" : "organisationUnit.json"
},
"selfRegistrationRole" : {
"$ref" : "userAuthorityGroup.json"
},
"systemId" : {
"type" : "string"
}
}
}
constant
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "number"
}
}
}
dashboard
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowedFilters" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboardItems" : {
"type" : "array",
"items" : {
"$ref" : "dashboardItem.json"
}
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"itemConfig" : {
"$ref" : "itemConfig.json"
},
"itemCount" : {
"type" : "integer"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layout" : {
"$ref" : "layout.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"restrictFilters" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dashboardItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"appKey" : {
"type" : "string"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentCount" : {
"type" : "integer"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"eventChart" : {
"$ref" : "eventChart.json"
},
"eventReport" : {
"$ref" : "eventReport.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"height" : {
"type" : "integer"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretationCount" : {
"type" : "integer"
},
"interpretationLikeCount" : {
"type" : "integer"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"map" : {
"$ref" : "map.json"
},
"messages" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"shape" : {
"$ref" : "dashboardItemShape.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "dashboardItemType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
},
"width" : {
"type" : "integer"
},
"x" : {
"type" : "integer"
},
"y" : {
"type" : "integer"
}
}
}
dashboardItemShape
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NORMAL", "DOUBLE_WIDTH", "FULL_WIDTH" ]
}
dashboardItemType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION", "EVENT_CHART", "MAP", "EVENT_REPORT", "USERS", "REPORTS", "RESOURCES", "TEXT", "MESSAGES", "APP" ]
}
dashboardSearchResult
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"appCount" : {
"type" : "integer"
},
"apps" : {
"type" : "array",
"items" : {
"$ref" : "app.json"
}
},
"eventChartCount" : {
"type" : "integer"
},
"eventCharts" : {
"type" : "array",
"items" : {
"$ref" : "eventChart.json"
}
},
"eventReportCount" : {
"type" : "integer"
},
"eventReports" : {
"type" : "array",
"items" : {
"$ref" : "eventReport.json"
}
},
"mapCount" : {
"type" : "integer"
},
"maps" : {
"type" : "array",
"items" : {
"$ref" : "map.json"
}
},
"reportCount" : {
"type" : "integer"
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"resourceCount" : {
"type" : "integer"
},
"resources" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"searchCount" : {
"type" : "integer"
},
"userCount" : {
"type" : "integer"
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"visualizationCount" : {
"type" : "integer"
},
"visualizations" : {
"type" : "array",
"items" : {
"$ref" : "simpleVisualizationView.json"
}
}
}
}
column
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"index" : {
"type" : "integer"
},
"span" : {
"type" : "integer"
}
}
}
itemConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"insertHeight" : {
"type" : "integer"
},
"insertPosition" : {
"$ref" : "position.json"
}
}
}
layout
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"columns" : {
"type" : "array",
"items" : {
"$ref" : "column.json"
}
},
"spacing" : {
"$ref" : "spacing.json"
}
}
}
position
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "START", "END" ]
}
spacing
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"row" : {
"type" : "integer"
}
}
}
dataAnalysisParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string"
},
"ou" : {
"type" : "string"
},
"standardDeviation" : {
"type" : "number"
},
"startDate" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"coc" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"de" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"ou" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startDate" : {
"type" : "string",
"format" : "date-time"
}
}
}
followupAnalysisResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followupValues" : {
"type" : "array",
"items" : {
"$ref" : "followupValue.json"
}
},
"metadata" : {
"$ref" : "followupAnalysisMetadata.json"
}
}
}
followupParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboId" : {
"type" : "integer"
},
"dataElementId" : {
"type" : "integer"
},
"followup" : {
"type" : "boolean"
},
"organisationUnitId" : {
"type" : "integer"
},
"periodId" : {
"type" : "integer"
}
}
}
followupValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"aoc" : {
"type" : "string"
},
"aocName" : {
"type" : "string"
},
"coc" : {
"type" : "string"
},
"cocName" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"de" : {
"type" : "string"
},
"deName" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"ou" : {
"type" : "string"
},
"ouName" : {
"type" : "string"
},
"ouPath" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"peEndDate" : {
"type" : "string",
"format" : "date-time"
},
"peName" : {
"type" : "string"
},
"peStartDate" : {
"type" : "string",
"format" : "date-time"
},
"peType" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
updateFollowUpForDataValuesRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followups" : {
"type" : "array",
"items" : {
"$ref" : "followupParams.json"
}
}
}
}
validationRuleExpressionDetails
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"leftSide" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"rightSide" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
validationRulesAnalysisParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"endDate" : {
"type" : "string"
},
"notification" : {
"type" : "boolean"
},
"ou" : {
"type" : "string"
},
"persist" : {
"type" : "boolean"
},
"startDate" : {
"type" : "string"
},
"vrg" : {
"type" : "string"
}
}
}
dataApproval
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalLevel" : {
"$ref" : "dataApprovalLevel.json"
}
}
}
dataApprovalAction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APPROVE", "UNAPPROVE", "ACCEPT", "UNACCEPT" ]
}
dataApprovalAndPermissions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalLevel" : {
"$ref" : "dataApprovalLevel.json"
}
}
}
dataApprovalAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"action" : {
"$ref" : "dataApprovalAction.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"creator" : {
"$ref" : "user.json"
},
"level" : {
"$ref" : "dataApprovalLevel.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"workflow" : {
"$ref" : "dataApprovalWorkflow.json"
}
}
}
dataApprovalLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionGroupSet" : {
"$ref" : "categoryOptionGroupSet.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"level" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"orgUnitLevel" : {
"type" : "integer"
},
"orgUnitLevelName" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataApprovalPermissions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"approvedAt" : {
"type" : "string",
"format" : "date-time"
},
"approvedBy" : {
"type" : "string"
},
"mayAccept" : {
"type" : "boolean"
},
"mayApprove" : {
"type" : "boolean"
},
"mayReadData" : {
"type" : "boolean"
},
"mayUnaccept" : {
"type" : "boolean"
},
"mayUnapprove" : {
"type" : "boolean"
},
"state" : {
"type" : "string"
}
}
}
dataApprovalState
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UNAPPROVABLE", "UNAPPROVED_ABOVE", "UNAPPROVED_WAITING", "UNAPPROVED_READY", "APPROVED_ABOVE", "APPROVED_HERE", "ACCEPTED_HERE" ]
}
dataApprovalStateRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ab" : {
"type" : "string"
},
"ad" : {
"type" : "string",
"format" : "date-time"
},
"ds" : {
"type" : "string"
},
"ou" : {
"type" : "string"
},
"pe" : {
"type" : "string"
}
}
}
dataApprovalStateResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"createdByUsername" : {
"type" : "string"
},
"createdDate" : {
"type" : "string",
"format" : "date-time"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"permissions" : {
"$ref" : "dataApprovalPermissions.json"
},
"state" : {
"type" : "string"
}
}
}
dataApprovalStateResponses
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataApprovalStateResponses" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalStateResponse.json"
}
}
}
}
dataApprovalWorkflow
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataApprovalLevels" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalLevel.json"
}
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
completeDataSetRegistrationRequest
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"cc" : {
"type" : "string"
},
"cd" : {
"type" : "string",
"format" : "date-time"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"ds" : {
"type" : "string"
},
"multiOu" : {
"type" : "boolean"
},
"ou" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"sb" : {
"type" : "string"
}
}
}
dataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"commentOptionSet" : {
"$ref" : "optionSet.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"dataSetElements" : {
"type" : "array",
"items" : {
"$ref" : "dataSetElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"domainType" : {
"$ref" : "dataElementDomain.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldMask" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetValue" : {
"type" : "boolean"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
},
"valueTypeOptions" : {
"type" : "object",
"properties" : {
"org.hisp.dhis.common.FileTypeValueOptions" : {
"$ref" : "fileTypeValueOptions.json"
}
},
"required" : [ "org.hisp.dhis.common.FileTypeValueOptions" ]
},
"zeroIsSignificant" : {
"type" : "boolean"
}
}
}
dataElementDomain
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE", "TRACKER" ]
}
dataElementGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataElementGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataElementGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElementGroupSet" : {
"$ref" : "dataElementGroupSet.json"
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
}
}
}
dataElementOperand
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
totalType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COC_ONLY", "AOC_ONLY", "COC_AND_AOC", "NONE" ]
}
dataEntryForm
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"format" : {
"type" : "integer"
},
"href" : {
"type" : "string"
},
"htmlCode" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"style" : {
"$ref" : "displayDensity.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
flattenedDataIntegrityReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElementsAssignedToDataSetsWithDifferentPeriodTypes" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsInDataSetNotInForm" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"dataElementsWithoutDataSet" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dataElementsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dataSetsNotAssignedToOrganisationUnits" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"duplicatePeriods" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"indicatorsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"indicatorsWithIdenticalFormulas" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"indicatorsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"invalidCategoryCombos" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"invalidIndicatorDenominators" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidIndicatorNumerators" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidProgramIndicatorExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidProgramIndicatorFilters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidValidationRuleLeftSideExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"invalidValidationRuleRightSideExpressions" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"organisationUnitGroupsWithoutGroupSets" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnitsViolatingExclusiveGroupSets" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"organisationUnitsWithCyclicReferences" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnitsWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"orphanedOrganisationUnits" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"programIndicatorsWithNoExpression" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"programRuleActionsWithNoDataObject" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoNotification" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoSectionId" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleActionsWithNoStageId" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleVariablesWithNoAttribute" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRuleVariablesWithNoDataElement" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoAction" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoCondition" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"programRulesWithNoPriority" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"validationRulesWithoutGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
dataItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"programId" : {
"type" : "string"
},
"shortName" : {
"type" : "string"
},
"simplifiedValueType" : {
"$ref" : "valueType.json"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
dataItemBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code(String)" : {
"$ref" : "#"
},
"dimensionItemType(DimensionItemType)" : {
"$ref" : "#"
},
"displayName(String)" : {
"$ref" : "#"
},
"displayShortName(String)" : {
"$ref" : "#"
},
"id(String)" : {
"$ref" : "#"
},
"name(String)" : {
"$ref" : "#"
},
"programId(String)" : {
"$ref" : "#"
},
"shortName(String)" : {
"$ref" : "#"
},
"simplifiedValueType(ValueType)" : {
"$ref" : "#"
},
"valueType(ValueType)" : {
"$ref" : "#"
}
}
}
queryableDataItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR", "DATA_ELEMENT", "DATA_SET", "PROGRAM_INDICATOR", "PROGRAM_DATA_ELEMENT", "PROGRAM_ATTRIBUTE" ]
}
completeDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"completed" : {
"type" : "boolean"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"date" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"storedBy" : {
"type" : "string"
}
}
}
completeDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"closingDate" : {
"type" : "string",
"format" : "date-time"
},
"openingDate" : {
"type" : "string",
"format" : "date-time"
},
"period" : {
"$ref" : "period.json"
}
}
}
dataSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"compulsoryDataElementOperands" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"compulsoryFieldsCompleteOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElementDecoration" : {
"type" : "boolean"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"dataInputPeriods" : {
"type" : "array",
"items" : {
"$ref" : "dataInputPeriod.json"
}
},
"dataSetElements" : {
"type" : "array",
"items" : {
"$ref" : "dataSetElement.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"expiryDays" : {
"type" : "integer"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldCombinationRequired" : {
"type" : "boolean"
},
"formName" : {
"type" : "string"
},
"formType" : {
"$ref" : "formType.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"mobile" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"noValueRequiresComment" : {
"type" : "boolean"
},
"notificationRecipients" : {
"$ref" : "userGroup.json"
},
"notifyCompletingUser" : {
"type" : "boolean"
},
"openFuturePeriods" : {
"type" : "integer"
},
"openPeriodsAfterCoEndDate" : {
"type" : "integer"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"renderAsTabs" : {
"type" : "boolean"
},
"renderHorizontally" : {
"type" : "boolean"
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "section.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipOffline" : {
"type" : "boolean"
},
"style" : {
"$ref" : "objectStyle.json"
},
"timelyDays" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validCompleteOnly" : {
"type" : "boolean"
},
"version" : {
"type" : "integer"
},
"workflow" : {
"$ref" : "dataApprovalWorkflow.json"
}
}
}
dataSetElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DEFAULT", "CUSTOM", "SECTION", "SECTION_MULTIORG" ]
}
lockException
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSet" : {
"$ref" : "dataSet.json"
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
}
}
}
section
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"description" : {
"type" : "string"
},
"disableDataElementAutoGroup" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"greyedFields" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"showColumnTotals" : {
"type" : "boolean"
},
"showRowTotals" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataSetNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_CONTACT", "USER_GROUP" ]
}
dataSetNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_CONTACT", "USER_GROUP" ]
}
dataSetNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSetNotificationTrigger" : {
"$ref" : "dataSetNotificationTrigger.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "dataSetNotificationRecipient.json"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroup" : {
"$ref" : "userGroup.json"
},
"relativeScheduledDays" : {
"type" : "integer"
},
"sendStrategy" : {
"$ref" : "sendStrategy.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
dataSetNotificationTemplateVariables
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NAME", "DATASET_DESCRIPTION", "COMPLETE_REG_OU", "COMPLETE_REG_PERIOD", "COMPLETE_REG_USER", "COMPLETE_REG_TIME", "COMPLETE_REG_ATT_OPT_COMBO", "CURRENT_DATE" ]
}
dataSetNotificationTemplateVariables
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NAME", "DATASET_DESCRIPTION", "COMPLETE_REG_OU", "COMPLETE_REG_PERIOD", "COMPLETE_REG_USER", "COMPLETE_REG_TIME", "COMPLETE_REG_ATT_OPT_COMBO", "CURRENT_DATE" ]
}
dataSetNotificationTrigger
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_SET_COMPLETION", "SCHEDULED_DAYS" ]
}
dbPoolTypes
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "C3P0", "HIKARI" ]
}
aggregatedStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activeUsers" : {
"type" : "integer"
},
"averageDashboardViews" : {
"type" : "integer"
},
"averageEventChartViews" : {
"type" : "integer"
},
"averageEventReportViews" : {
"type" : "integer"
},
"averageMapViews" : {
"type" : "integer"
},
"averagePassiveDashboardViews" : {
"type" : "integer"
},
"averageViews" : {
"type" : "integer"
},
"averageVisualizationViews" : {
"type" : "integer"
},
"dashboardViews" : {
"type" : "integer"
},
"dataSetReportViews" : {
"type" : "integer"
},
"day" : {
"type" : "integer"
},
"eventChartViews" : {
"type" : "integer"
},
"eventReportViews" : {
"type" : "integer"
},
"mapViews" : {
"type" : "integer"
},
"month" : {
"type" : "integer"
},
"passiveDashboardViews" : {
"type" : "integer"
},
"savedDashboards" : {
"type" : "integer"
},
"savedDataValues" : {
"type" : "integer"
},
"savedEventCharts" : {
"type" : "integer"
},
"savedEventReports" : {
"type" : "integer"
},
"savedIndicators" : {
"type" : "integer"
},
"savedMaps" : {
"type" : "integer"
},
"savedVisualizations" : {
"type" : "integer"
},
"totalViews" : {
"type" : "integer"
},
"users" : {
"type" : "integer"
},
"visualizationViews" : {
"type" : "integer"
},
"week" : {
"type" : "integer"
},
"year" : {
"type" : "integer"
}
}
}
dataStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"activeUsers" : {
"type" : "integer"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboardViews" : {
"type" : "number"
},
"dataSetReportViews" : {
"type" : "number"
},
"displayName" : {
"type" : "string"
},
"eventChartViews" : {
"type" : "number"
},
"eventReportViews" : {
"type" : "number"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mapViews" : {
"type" : "number"
},
"name" : {
"type" : "string"
},
"passiveDashboardViews" : {
"type" : "number"
},
"publicAccess" : {
"type" : "string"
},
"savedDashboards" : {
"type" : "number"
},
"savedDataValues" : {
"type" : "number"
},
"savedEventCharts" : {
"type" : "number"
},
"savedEventReports" : {
"type" : "number"
},
"savedIndicators" : {
"type" : "number"
},
"savedMaps" : {
"type" : "number"
},
"savedVisualizations" : {
"type" : "number"
},
"sharing" : {
"$ref" : "sharing.json"
},
"totalViews" : {
"type" : "number"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "integer"
},
"visualizationViews" : {
"type" : "number"
}
}
}
dataStatisticsEventType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VISUALIZATION_VIEW", "MAP_VIEW", "EVENT_REPORT_VIEW", "EVENT_CHART_VIEW", "DASHBOARD_VIEW", "PASSIVE_DASHBOARD_VIEW", "DATA_SET_REPORT_VIEW", "TOTAL_VIEW" ]
}
eventInterval
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAY", "WEEK", "MONTH", "YEAR" ]
}
favoriteStatistics
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"position" : {
"type" : "integer"
},
"views" : {
"type" : "integer"
}
}
}
dataSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"activeUsers" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"dataValueCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"eventCount" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"objectCounts" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"userInvitations" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
}
}
}
dataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"period" : {
"$ref" : "period.json"
},
"source" : {
"$ref" : "organisationUnit.json"
},
"value" : {
"type" : "string"
}
}
}
dataValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"auditType" : {
"$ref" : "auditType_.json"
},
"categoryOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"modifiedBy" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"value" : {
"type" : "string"
}
}
}
deflatedDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboId" : {
"type" : "integer"
},
"categoryOptionComboName" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"dataElementId" : {
"type" : "integer"
},
"dataElementName" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"period" : {
"$ref" : "period.json"
},
"periodId" : {
"type" : "integer"
},
"sourceId" : {
"type" : "integer"
},
"sourceName" : {
"type" : "string"
},
"sourcePath" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
deduplicationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "OPEN", "INVALID", "MERGED" ]
}
mergeObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relationships" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
mergeObjectBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments(List<String>)" : {
"$ref" : "#"
},
"relationships(List<String>)" : {
"$ref" : "#"
},
"trackedEntityAttributes(List<String>)" : {
"$ref" : "#"
}
}
}
mergeStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MANUAL", "AUTO" ]
}
potentialDuplicate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"duplicate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserName" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"original" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "deduplicationStatus.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
deletedObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"deletedAt" : {
"type" : "string",
"format" : "date-time"
},
"deletedBy" : {
"type" : "string"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
document
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attachment" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentType" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"external" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
duration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "P1D", "P7D", "P14D", "P1M", "P2M", "P3M", "P6M", "P1Y" ]
}
importOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"async" : {
"type" : "boolean"
},
"datasetAllowsPeriods" : {
"type" : "boolean"
},
"dryRun" : {
"type" : "boolean"
},
"filename" : {
"type" : "string"
},
"firstRowIsHeader" : {
"type" : "boolean"
},
"force" : {
"type" : "boolean"
},
"idSchemes" : {
"$ref" : "idSchemes.json"
},
"ignoreEmptyCollection" : {
"type" : "boolean"
},
"importStrategy" : {
"$ref" : "importStrategy.json"
},
"mergeDataValues" : {
"type" : "boolean"
},
"mergeMode" : {
"$ref" : "mergeMode.json"
},
"notificationLevel" : {
"$ref" : "notificationLevel.json"
},
"preheatCache" : {
"type" : "boolean"
},
"reportMode" : {
"$ref" : "importReportMode.json"
},
"requireAttributeOptionCombo" : {
"type" : "boolean"
},
"requireCategoryOptionCombo" : {
"type" : "boolean"
},
"sharing" : {
"type" : "boolean"
},
"skipAudit" : {
"type" : "boolean"
},
"skipCache" : {
"type" : "boolean"
},
"skipExistingCheck" : {
"type" : "boolean"
},
"skipLastUpdated" : {
"type" : "boolean"
},
"skipNotifications" : {
"type" : "boolean"
},
"skipPatternValidation" : {
"type" : "boolean"
},
"strictAttributeOptionCombos" : {
"type" : "boolean"
},
"strictCategoryOptionCombos" : {
"type" : "boolean"
},
"strictDataElements" : {
"type" : "boolean"
},
"strictOrganisationUnits" : {
"type" : "boolean"
},
"strictPeriods" : {
"type" : "boolean"
}
}
}
importSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importCount" : {
"$ref" : "importCount.json"
},
"importTypeSummaries" : {
"type" : "array",
"items" : {
"$ref" : "importTypeSummary.json"
}
}
}
}
importTypeSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"conflicts" : {
"type" : "object"
},
"dataSetComplete" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enrollments" : {
"$ref" : "importSummaries.json"
},
"events" : {
"$ref" : "importSummaries.json"
},
"href" : {
"type" : "string"
},
"importConflicts" : {
"type" : "array",
"items" : {
"$ref" : "importConflict.json"
}
},
"importCount" : {
"$ref" : "importCount.json"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"lastImported" : {
"type" : "string"
},
"reference" : {
"type" : "string"
},
"relationships" : {
"$ref" : "importSummaries.json"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
},
"type" : {
"type" : "string"
}
}
}
csvImportClass
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORGANISATION_UNIT_GROUP_MEMBERSHIP", "DATA_ELEMENT_GROUP_MEMBERSHIP", "INDICATOR_GROUP_MEMBERSHIP", "DATA_ELEMENT", "DATA_ELEMENT_GROUP", "CATEGORY_OPTION", "CATEGORY", "CATEGORY_COMBO", "CATEGORY_OPTION_GROUP", "ORGANISATION_UNIT", "ORGANISATION_UNIT_GROUP", "VALIDATION_RULE", "OPTION_SET", "OPTION_GROUP", "OPTION_GROUP_SET", "OPTION_GROUP_SET_MEMBERSHIP" ]
}
completeDataSetRegistration_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
completeDataSetRegistrations_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingJsonCompleteDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
streamingJsonCompleteDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingXmlCompleteDataSetRegistration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"cc" : {
"type" : "string"
},
"completed" : {
"type" : "boolean"
},
"cp" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"date" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedBy" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
}
}
}
streamingXmlCompleteDataSetRegistrations
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionComboIdScheme" : {
"type" : "string"
},
"completeDataSetRegistrations" : {
"type" : "array",
"items" : {
"$ref" : "completeDataSetRegistration_.json"
}
},
"dataSetIdScheme" : {
"type" : "string"
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
dataValue_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingCsvDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingJsonDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
streamingXmlDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionCombo" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"deleted" : {
"type" : "boolean"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
dataValueImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT_NOT_FOUND", "PERIOD_NOT_VALID", "ORG_UNIT_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_ACCESSIBLE", "ATTR_OPTION_COMBO_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_ACCESSIBLE", "ORG_UNIT_NOT_IN_USER_HIERARCHY", "DATA_ELEMENT_VALUE_NOT_DEFINED", "DATA_ELEMENT_VALUE_NOT_VALID", "COMMENT_NOT_VALID", "DATA_ELEMENT_INVALID_OPTION", "CATEGORY_OPTION_COMBO_NOT_SPECIFIED", "ATTR_OPTION_COMBO_NOT_SPECIFIED", "PERIOD_TYPE_NOT_VALID_FOR_DATA_ELEMENT", "DATA_ELEMENT_STRICT", "CATEGORY_OPTION_COMBO_STRICT", "ATTR_OPTION_COMBO_STRICT", "ORG_UNIT_STRICT", "STORED_BY_NOT_VALID", "PERIOD_NOT_VALID_FOR_ATTR_OPTION_COMBO", "ORG_UNIT_NOT_VALID_FOR_ATTR_OPTION_COMBO", "PERIOD_EXPIRED", "PERIOD_AFTER_DATA_ELEMENT_PERIODS", "VALUE_ALREADY_APPROVED", "PERIOD_NOT_OPEN_FOR_DATA_SET", "PERIOD_NOT_CONFORM_TO_OPEN_PERIODS", "FILE_RESOURCE_NOT_FOUND" ]
}
dataValueImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT_NOT_FOUND", "PERIOD_NOT_VALID", "ORG_UNIT_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_FOUND", "CATEGORY_OPTION_COMBO_NOT_ACCESSIBLE", "ATTR_OPTION_COMBO_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_ACCESSIBLE", "ORG_UNIT_NOT_IN_USER_HIERARCHY", "DATA_ELEMENT_VALUE_NOT_DEFINED", "DATA_ELEMENT_VALUE_NOT_VALID", "COMMENT_NOT_VALID", "DATA_ELEMENT_INVALID_OPTION", "CATEGORY_OPTION_COMBO_NOT_SPECIFIED", "ATTR_OPTION_COMBO_NOT_SPECIFIED", "PERIOD_TYPE_NOT_VALID_FOR_DATA_ELEMENT", "DATA_ELEMENT_STRICT", "CATEGORY_OPTION_COMBO_STRICT", "ATTR_OPTION_COMBO_STRICT", "ORG_UNIT_STRICT", "STORED_BY_NOT_VALID", "PERIOD_NOT_VALID_FOR_ATTR_OPTION_COMBO", "ORG_UNIT_NOT_VALID_FOR_ATTR_OPTION_COMBO", "PERIOD_EXPIRED", "PERIOD_AFTER_DATA_ELEMENT_PERIODS", "VALUE_ALREADY_APPROVED", "PERIOD_NOT_OPEN_FOR_DATA_SET", "PERIOD_NOT_CONFORM_TO_OPEN_PERIODS", "FILE_RESOURCE_NOT_FOUND" ]
}
dataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
dataValueSetImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NOT_FOUND", "DATASET_NOT_ACCESSIBLE", "DATASET_NOT_VALID", "ORG_UNIT_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_FOUND" ]
}
dataValueSetImportConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATASET_NOT_FOUND", "DATASET_NOT_ACCESSIBLE", "DATASET_NOT_VALID", "ORG_UNIT_NOT_FOUND", "ATTR_OPTION_COMBO_NOT_FOUND" ]
}
streamingCsvDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingJsonDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
streamingXmlDataValueSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attributeOptionCombo" : {
"type" : "string"
},
"categoryOptionComboIdScheme" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"dataElementIdScheme" : {
"type" : "string"
},
"dataSet" : {
"type" : "string"
},
"dataSetIdScheme" : {
"type" : "string"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue_.json"
}
},
"dryRun" : {
"type" : "boolean"
},
"idScheme" : {
"type" : "string"
},
"orgUnit" : {
"type" : "string"
},
"orgUnitIdScheme" : {
"type" : "string"
},
"period" : {
"type" : "string"
},
"strategy" : {
"type" : "string"
}
}
}
relationshipParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"includeFrom" : {
"type" : "boolean"
},
"includeTo" : {
"type" : "boolean"
}
}
}
trackedEntityInstanceParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSynchronizationQuery" : {
"type" : "boolean"
},
"includeDeleted" : {
"type" : "boolean"
},
"includeEnrollments" : {
"type" : "boolean"
},
"includeEvents" : {
"type" : "boolean"
},
"includeProgramOwners" : {
"type" : "boolean"
},
"includeRelationships" : {
"type" : "boolean"
}
}
}
enrollment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string",
"format" : "date-time"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"enrollment" : {
"type" : "string"
},
"enrollmentDate" : {
"type" : "string",
"format" : "date-time"
},
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"incidentDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"status" : {
"$ref" : "enrollmentStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityType" : {
"type" : "string"
}
},
"required" : [ "created", "createdAtClient", "enrollment", "enrollmentDate", "incidentDate", "lastUpdated", "lastUpdatedAtClient", "program", "status", "trackedEntityInstance", "trackedEntityType" ]
}
enrollmentStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
enrollments
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollments" : {
"type" : "array",
"items" : {
"$ref" : "enrollment.json"
}
}
}
}
dataValue__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"dataElement" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
event
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUser" : {
"type" : "string"
},
"assignedUserDisplayName" : {
"type" : "string"
},
"assignedUserUsername" : {
"type" : "string"
},
"attributeCategoryOptions" : {
"type" : "string"
},
"attributeOptionCombo" : {
"type" : "string"
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue__.json"
}
},
"deleted" : {
"type" : "boolean"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"enrollmentStatus" : {
"$ref" : "enrollmentStatus.json"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"programType" : {
"$ref" : "programType.json"
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"status" : {
"$ref" : "eventStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
}
},
"required" : [ "createdAtClient", "enrollment", "enrollmentStatus", "event", "eventDate", "lastUpdatedAtClient", "program", "programStage", "programType", "status" ]
}
events
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"metaData" : {
"type" : "object"
},
"pager" : {
"$ref" : "pager.json"
},
"program" : {
"type" : "string"
},
"programInstance" : {
"type" : "string"
}
}
}
note
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "userInfoSnapshot.json"
},
"note" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"storedDate" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
csvEventDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string"
},
"dataElement" : {
"type" : "string"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"geometry" : {
"type" : "string"
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"orgUnit" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"providedElsewhere" : {
"type" : "boolean"
},
"status" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
eventRow
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeCategoryOptions" : {
"type" : "string"
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"dataValues" : {
"type" : "array",
"items" : {
"$ref" : "dataValue__.json"
}
},
"deleted" : {
"type" : "boolean"
},
"dueDate" : {
"type" : "string"
},
"enrollment" : {
"type" : "string"
},
"event" : {
"type" : "string"
},
"eventDate" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"notes" : {
"type" : "array",
"items" : {
"$ref" : "note.json"
}
},
"orgUnit" : {
"type" : "string"
},
"orgUnitName" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityInstanceCreated" : {
"type" : "string"
},
"trackedEntityInstanceInactive" : {
"type" : "boolean"
},
"trackedEntityInstanceOrgUnit" : {
"type" : "string"
},
"trackedEntityInstanceOrgUnitName" : {
"type" : "string"
}
},
"required" : [ "eventDate" ]
}
eventRows
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"eventRows" : {
"type" : "array",
"items" : {
"$ref" : "eventRow.json"
}
},
"pager" : {
"$ref" : "pager.json"
}
}
}
attribute_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ownerOrgUnit" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
}
}
}
relationship
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"bidirectional" : {
"type" : "boolean"
},
"created" : {
"type" : "string"
},
"from" : {
"$ref" : "relationshipItem.json"
},
"lastUpdated" : {
"type" : "string"
},
"relationship" : {
"type" : "string"
},
"relationshipName" : {
"type" : "string"
},
"relationshipType" : {
"type" : "string"
},
"to" : {
"$ref" : "relationshipItem.json"
}
}
}
relationshipItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enrollment" : {
"$ref" : "enrollment.json"
},
"event" : {
"$ref" : "event.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance.json"
}
}
}
relationships
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
}
}
}
trackedEntityInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute_.json"
}
},
"coordinates" : {
"type" : "string"
},
"created" : {
"type" : "string"
},
"createdAtClient" : {
"type" : "string"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"enrollments" : {
"type" : "array",
"items" : {
"$ref" : "enrollment.json"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"geometry" : {
"$ref" : "geometry.json"
},
"inactive" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string"
},
"lastUpdatedAtClient" : {
"type" : "string"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"orgUnit" : {
"type" : "string"
},
"potentialDuplicate" : {
"type" : "boolean"
},
"programOwners" : {
"type" : "array",
"items" : {
"$ref" : "programOwner.json"
}
},
"relationships" : {
"type" : "array",
"items" : {
"$ref" : "relationship.json"
}
},
"storedBy" : {
"type" : "string"
},
"trackedEntityInstance" : {
"type" : "string"
},
"trackedEntityType" : {
"type" : "string"
}
},
"required" : [ "created", "createdAtClient", "lastUpdated", "lastUpdatedAtClient", "orgUnit", "trackedEntityInstance", "trackedEntityType" ]
}
trackedEntityInstances
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"trackedEntityInstances" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityInstance.json"
}
}
}
}
cOLUMNS
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEI_UID", "ID", "UID", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "STATUS", "GEOMETRY", "ENROLLMENTDATE", "INCIDENTDATE", "FOLLOWUP", "COMPLETED", "COMPLETEDBY", "STOREDBY", "DELETED", "PROGRAM_UID", "PROGRAM_FEATURE_TYPE", "TEI_TYPE_UID", "ORGUNIT_UID", "ORGUNIT_NAME" ]
}
cOLUMNS_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "UID", "STATUS", "EXECUTION_DATE", "DUE_DATE", "STOREDBY", "COMPLETEDBY", "COMPLETEDDATE", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "DELETED", "GEOMETRY", "TEI_UID", "ENROLLMENT_UID", "ENROLLMENT_FOLLOWUP", "ENROLLMENT_STATUS", "PROGRAM_UID", "PROGRAM_STAGE_UID", "ORGUNIT_UID", "ORGUNIT_NAME", "COC_UID", "CAT_OPTIONS" ]
}
cOLUMNS__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEI_UID", "TEI_ID", "CREATED", "UPDATED", "VALUE", "STOREDBY", "ATTR_UID", "ATTR_NAME", "ATTR_VALUE_TYPE", "ATTR_CODE", "ATTR_SKIP_SYNC" ]
}
cOLUMNS___
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UID", "CREATED", "CREATEDCLIENT", "UPDATED", "UPDATEDCLIENT", "INACTIVE", "DELETED", "GEOMETRY", "TYPE_UID", "ORGUNIT_UID", "TRACKEDENTITYINSTANCEID" ]
}
importConflict
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"object" : {
"type" : "string"
},
"objects" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"property" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
importCount
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"imported" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
importStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "WARNING", "ERROR" ]
}
importSummaries
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"importSummaries" : {
"type" : "array",
"items" : {
"$ref" : "importSummary_.json"
}
},
"imported" : {
"type" : "integer"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
},
"total" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
importSummary_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"conflicts" : {
"type" : "object"
},
"dataSetComplete" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"enrollments" : {
"$ref" : "importSummaries.json"
},
"events" : {
"$ref" : "importSummaries.json"
},
"href" : {
"type" : "string"
},
"importCount" : {
"$ref" : "importCount.json"
},
"importOptions" : {
"$ref" : "importOptions.json"
},
"reference" : {
"type" : "string"
},
"relationships" : {
"$ref" : "importSummaries.json"
},
"responseType" : {
"type" : "string"
},
"status" : {
"$ref" : "importStatus.json"
}
}
}
atomicMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL", "NONE" ]
}
flushMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OBJECT", "AUTO" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"analyticsTableHooks" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableHook.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "attribute.json"
}
},
"categories" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"categoryCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryCombo.json"
}
},
"categoryOptionCombos" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionCombo.json"
}
},
"categoryOptionGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"categoryOptionGroups" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroup.json"
}
},
"categoryOptions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOption.json"
}
},
"constants" : {
"type" : "array",
"items" : {
"$ref" : "constant.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dashboardItems" : {
"type" : "array",
"items" : {
"$ref" : "dashboardItem.json"
}
},
"dashboards" : {
"type" : "array",
"items" : {
"$ref" : "dashboard.json"
}
},
"dataApprovalLevels" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalLevel.json"
}
},
"dataApprovalWorkflows" : {
"type" : "array",
"items" : {
"$ref" : "dataApprovalWorkflow.json"
}
},
"dataElementGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSet.json"
}
},
"dataElementGroups" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroup.json"
}
},
"dataElementOperands" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"dataEntryForms" : {
"type" : "array",
"items" : {
"$ref" : "dataEntryForm.json"
}
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"dimensions" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"documents" : {
"type" : "array",
"items" : {
"$ref" : "document.json"
}
},
"eventCharts" : {
"type" : "array",
"items" : {
"$ref" : "eventChart.json"
}
},
"eventReports" : {
"type" : "array",
"items" : {
"$ref" : "eventReport.json"
}
},
"events" : {
"type" : "array",
"items" : {
"$ref" : "event.json"
}
},
"externalMapLayers" : {
"type" : "array",
"items" : {
"$ref" : "externalMapLayer.json"
}
},
"indicatorGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroupSet.json"
}
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"indicatorTypes" : {
"type" : "array",
"items" : {
"$ref" : "indicatorType.json"
}
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "nameableObject.json"
}
},
"jobConfigurations" : {
"type" : "array",
"items" : {
"$ref" : "jobConfiguration.json"
}
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"mapViews" : {
"type" : "array",
"items" : {
"$ref" : "mapView.json"
}
},
"maps" : {
"type" : "array",
"items" : {
"$ref" : "map.json"
}
},
"metadataVersions" : {
"type" : "array",
"items" : {
"$ref" : "metadataVersion.json"
}
},
"optionGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "optionGroupSet.json"
}
},
"optionGroups" : {
"type" : "array",
"items" : {
"$ref" : "optionGroup.json"
}
},
"optionSets" : {
"type" : "array",
"items" : {
"$ref" : "optionSet.json"
}
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"organisationUnitGroupSets" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSet.json"
}
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitLevel.json"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"predictorGroups" : {
"type" : "array",
"items" : {
"$ref" : "predictorGroup.json"
}
},
"predictors" : {
"type" : "array",
"items" : {
"$ref" : "predictor.json"
}
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programNotificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"programRuleActions" : {
"type" : "array",
"items" : {
"$ref" : "programRuleAction.json"
}
},
"programRuleVariables" : {
"type" : "array",
"items" : {
"$ref" : "programRuleVariable.json"
}
},
"programRules" : {
"type" : "array",
"items" : {
"$ref" : "programRule.json"
}
},
"programStageSections" : {
"type" : "array",
"items" : {
"$ref" : "programStageSection.json"
}
},
"programStages" : {
"type" : "array",
"items" : {
"$ref" : "programStage.json"
}
},
"programs" : {
"type" : "array",
"items" : {
"$ref" : "program.json"
}
},
"relationshipTypes" : {
"type" : "array",
"items" : {
"$ref" : "relationshipType.json"
}
},
"reports" : {
"type" : "array",
"items" : {
"$ref" : "report.json"
}
},
"schemas" : {
"type" : "array",
"items" : {
"$ref" : "schema.json"
}
},
"sections" : {
"type" : "array",
"items" : {
"$ref" : "section.json"
}
},
"sqlViews" : {
"type" : "array",
"items" : {
"$ref" : "sqlView.json"
}
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttribute.json"
}
},
"trackedEntityTypes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityType.json"
}
},
"userGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"validationNotificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "validationNotificationTemplate.json"
}
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"$ref" : "validationRuleGroup.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"atomicMode" : {
"$ref" : "atomicMode.json"
},
"csvImportClass" : {
"$ref" : "csvImportClass.json"
},
"filename" : {
"type" : "string"
},
"firstRowIsHeader" : {
"type" : "boolean"
},
"flushMode" : {
"$ref" : "flushMode.json"
},
"identifier" : {
"$ref" : "preheatIdentifier.json"
},
"importMode" : {
"$ref" : "objectBundleMode.json"
},
"importReportMode" : {
"$ref" : "importReportMode.json"
},
"importStrategy" : {
"$ref" : "importStrategy.json"
},
"mergeMode" : {
"$ref" : "mergeMode.json"
},
"metadataSyncImport" : {
"type" : "boolean"
},
"preheatMode" : {
"$ref" : "preheatMode.json"
},
"skipSharing" : {
"type" : "boolean"
},
"skipTranslation" : {
"type" : "boolean"
},
"skipValidation" : {
"type" : "boolean"
},
"userOverrideMode" : {
"$ref" : "userOverrideMode.json"
},
"username" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"metadata" : {
"type" : "string"
}
}
}
userOverrideMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "CURRENT", "SELECTED" ]
}
importReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importParams" : {
"$ref" : "metadataImportParams.json"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
},
"typeReports" : {
"type" : "array",
"items" : {
"$ref" : "typeReport.json"
}
}
}
}
importReportMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FULL", "ERRORS", "ERRORS_NOT_OWNER", "DEBUG" ]
}
objectBundleMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMMIT", "VALIDATE" ]
}
objectBundleStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATED", "VALIDATED", "COMMITTED" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"importReport" : {
"$ref" : "importReport.json"
},
"importSummary" : {
"$ref" : "importSummary.json"
},
"metadataVersion" : {
"$ref" : "metadataVersion.json"
}
}
}
jobConfigurationWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"id" : {
"type" : "string"
},
"jobParameters" : {
"$ref" : "jobParameters.json"
},
"jobStatus" : {
"$ref" : "jobStatus.json"
},
"jobType" : {
"$ref" : "jobType.json"
},
"name" : {
"type" : "string"
},
"relativeNotifierEndpoint" : {
"type" : "string"
}
}
}
syncEndpoint
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCES", "ENROLLMENTS", "EVENTS", "COMPLETE_DATA_SET_REGISTRATIONS", "DATA_VALUE_SETS" ]
}
synchronizationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "FAILURE" ]
}
availabilityStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"available" : {
"type" : "boolean"
},
"message" : {
"type" : "string"
},
"statusCode" : {
"type" : "integer"
},
"statusPhrase" : {
"type" : "string"
}
}
}
abstractWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"responseType" : {
"type" : "string"
}
}
}
descriptiveWebMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "integer"
},
"description" : {
"type" : "string"
},
"devMessage" : {
"type" : "string"
},
"errorCode" : {
"$ref" : "errorCode.json"
},
"httpStatus" : {
"type" : "string"
},
"httpStatusCode" : {
"type" : "integer"
},
"message" : {
"type" : "string"
},
"response" : {
"$ref" : "webMessageResponse.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
webMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "integer"
},
"devMessage" : {
"type" : "string"
},
"errorCode" : {
"$ref" : "errorCode.json"
},
"httpStatus" : {
"type" : "string"
},
"httpStatusCode" : {
"type" : "integer"
},
"message" : {
"type" : "string"
},
"response" : {
"$ref" : "webMessageResponse.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
webMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
errorReportsWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"responseType" : {
"type" : "string"
}
}
}
fileResourceWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fileResource" : {
"$ref" : "fileResource.json"
},
"responseType" : {
"type" : "string"
}
}
}
importCountWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "integer"
},
"deleted" : {
"type" : "integer"
},
"responseType" : {
"type" : "string"
},
"updated" : {
"type" : "integer"
}
}
}
importReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"responseType" : {
"type" : "string"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
},
"typeReports" : {
"type" : "array",
"items" : {
"$ref" : "typeReport.json"
}
}
}
}
objectReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"klass" : {
"type" : "string"
},
"responseType" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
typeReportWebMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"objectReports" : {
"type" : "array",
"items" : {
"$ref" : "objectReport.json"
}
},
"responseType" : {
"type" : "string"
},
"stats" : {
"$ref" : "stats.json"
},
"status" : {
"$ref" : "status.json"
}
}
}
email
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"recipients" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"sender" : {
"$ref" : "user.json"
},
"subject" : {
"type" : "string"
},
"text" : {
"type" : "string"
}
}
}
emailResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SENT", "FAILED", "ABORTED", "NOT_CONFIGURED", "HOST_CONFIG_NOT_FOUND" ]
}
encryptionStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "MISSING_JCE_POLICY", "MISSING_ENCRYPTION_PASSWORD", "ENCRYPTION_PASSWORD_TOO_SHORT" ]
}
eventStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "VISITED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
baseChart
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"baseLineLabel" : {
"type" : "string"
},
"baseLineValue" : {
"type" : "number"
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideLegend" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendDisplayStrategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer"
},
"rangeAxisLabel" : {
"type" : "string"
},
"rangeAxisMaxValue" : {
"type" : "number"
},
"rangeAxisMinValue" : {
"type" : "number"
},
"rangeAxisSteps" : {
"type" : "integer"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string"
},
"targetLineValue" : {
"type" : "number"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
eventChart
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValueDimension" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"baseLineLabel" : {
"type" : "string"
},
"baseLineValue" : {
"type" : "number"
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"collapseDataDimensions" : {
"type" : "boolean"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"dataElementValueDimension" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"formName" : {
"type" : "string"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideLegend" : {
"type" : "boolean"
},
"hideNaData" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendDisplayStrategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outputType" : {
"$ref" : "eventOutputType.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer"
},
"rangeAxisLabel" : {
"type" : "string"
},
"rangeAxisMaxValue" : {
"type" : "number"
},
"rangeAxisMinValue" : {
"type" : "number"
},
"rangeAxisSteps" : {
"type" : "integer"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string"
},
"targetLineValue" : {
"type" : "number"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"value" : {
"$ref" : "dimensionalItemObject.json"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
eventDataValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"storedBy" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
eventReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValueDimension" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"colSubTotals" : {
"type" : "boolean"
},
"colTotals" : {
"type" : "boolean"
},
"collapseDataDimensions" : {
"type" : "boolean"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"dataElementValueDimension" : {
"$ref" : "dataElement.json"
},
"dataType" : {
"$ref" : "eventDataType.json"
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDensity" : {
"$ref" : "displayDensity.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"fontSize" : {
"$ref" : "fontSize.json"
},
"formName" : {
"type" : "string"
},
"hideEmptyRows" : {
"type" : "boolean"
},
"hideNaData" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outputType" : {
"$ref" : "eventOutputType.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rowSubTotals" : {
"type" : "boolean"
},
"rowTotals" : {
"type" : "boolean"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showDimensionLabels" : {
"type" : "boolean"
},
"showHierarchy" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"value" : {
"$ref" : "dimensionalItemObject.json"
}
}
}
expression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"missingValueStrategy" : {
"$ref" : "missingValueStrategy.json"
},
"slidingWindow" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
}
}
}
expressionValidationOutcome
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VALID", "EXPRESSION_IS_EMPTY", "DIMENSIONAL_ITEM_OBJECT_DOES_NOT_EXIST", "CONSTANT_DOES_NOT_EXIST", "ORG_UNIT_GROUP_DOES_NOT_EXIST", "EXPRESSION_IS_NOT_WELL_FORMED" ]
}
missingValueStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SKIP_IF_ANY_VALUE_MISSING", "SKIP_IF_ALL_VALUES_MISSING", "NEVER_SKIP" ]
}
operator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "equal_to", "not_equal_to", "greater_than", "greater_than_or_equal_to", "less_than", "less_than_or_equal_to", "compulsory_pair", "exclusive_pair" ]
}
parseType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INDICATOR_EXPRESSION", "VALIDATION_RULE_EXPRESSION", "PREDICTOR_EXPRESSION", "PREDICTOR_SKIP_TEST", "SIMPLE_TEST" ]
}
configurationKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SYSTEM_READ_ONLY_MODE", "SYSTEM_SESSION_TIMEOUT", "SYSTEM_MONITORING_URL", "SYSTEM_MONITORING_USERNAME", "SYSTEM_MONITORING_PASSWORD", "SYSTEM_SQL_VIEW_TABLE_PROTECTION", "SYSTEM_PROGRAM_RULE_SERVER_EXECUTION", "SYSTEM_CACHE_MAX_SIZE_FACTOR", "SYSTEM_CACHE_CAP_PERCENTAGE", "NODE_ID", "ENCRYPTION_PASSWORD", "CONNECTION_DIALECT", "CONNECTION_DRIVER_CLASS", "CONNECTION_URL", "CONNECTION_USERNAME", "CONNECTION_PASSWORD", "CONNECTION_SCHEMA", "CONNECTION_POOL_MAX_SIZE", "CONNECTION_POOL_MIN_SIZE", "CONNECTION_POOL_INITIAL_SIZE", "CONNECTION_POOL_ACQUIRE_INCR", "CONNECTION_POOL_MAX_IDLE_TIME", "CONNECTION_POOL_MAX_IDLE_TIME_EXCESS_CON", "CONNECTION_POOL_IDLE_CON_TEST_PERIOD", "CONNECTION_POOL_TEST_ON_CHECKOUT", "CONNECTION_POOL_TEST_ON_CHECKIN", "CONNECTION_POOL_TIMEOUT", "CONNECTION_POOL_VALIDATION_TIMEOUT", "CONNECTION_POOL_NUM_THREADS", "CONNECTION_POOL_TEST_QUERY", "LDAP_URL", "LDAP_MANAGER_DN", "LDAP_MANAGER_PASSWORD", "LDAP_SEARCH_BASE", "LDAP_SEARCH_FILTER", "FILESTORE_PROVIDER", "FILESTORE_CONTAINER", "FILESTORE_LOCATION", "FILESTORE_IDENTITY", "FILESTORE_SECRET", "GOOGLE_SERVICE_ACCOUNT_CLIENT_ID", "META_DATA_SYNC_RETRY", "META_DATA_SYNC_RETRY_TIME_FREQUENCY_MILLISEC", "CLUSTER_HOSTNAME", "CLUSTER_MEMBERS", "CLUSTER_CACHE_PORT", "CLUSTER_CACHE_REMOTE_OBJECT_PORT", "REDIS_HOST", "REDIS_PORT", "REDIS_PASSWORD", "REDIS_ENABLED", "REDIS_USE_SSL", "FLYWAY_OUT_OF_ORDER_MIGRATION", "FLYWAY_REPAIR_BEFORE_MIGRATION", "PROGRAM_TEMPORARY_OWNERSHIP_TIMEOUT", "LEADER_TIME_TO_LIVE", "ANALYTICS_CACHE_EXPIRATION", "ARTEMIS_MODE", "ARTEMIS_HOST", "ARTEMIS_PORT", "ARTEMIS_USERNAME", "ARTEMIS_PASSWORD", "ARTEMIS_EMBEDDED_SECURITY", "ARTEMIS_EMBEDDED_PERSISTENCE", "ARTEMIS_EMBEDDED_THREADS", "LOGGING_FILE_MAX_SIZE", "LOGGING_FILE_MAX_ARCHIVES", "LOGGING_REQUEST_ID_HASH", "LOGGING_REQUEST_ID_ENABLED", "LOGGING_REQUEST_ID_MAX_SIZE", "SERVER_BASE_URL", "SERVER_HTTPS", "MONITORING_PROVIDER", "MONITORING_API_ENABLED", "MONITORING_JVM_ENABLED", "MONITORING_DBPOOL_ENABLED", "MONITORING_HIBERNATE_ENABLED", "MONITORING_UPTIME_ENABLED", "MONITORING_CPU_ENABLED", "APPHUB_BASE_URL", "APPHUB_API_URL", "CHANGELOG_AGGREGATE", "CHANGELOG_TRACKER", "AUDIT_USE_INMEMORY_QUEUE_ENABLED", "AUDIT_USE_IN_MEMORY_QUEUE_ENABLED", "AUDIT_LOGGER", "AUDIT_DATABASE", "AUDIT_METADATA_MATRIX", "AUDIT_TRACKER_MATRIX", "AUDIT_AGGREGATE_MATRIX", "OIDC_OAUTH2_LOGIN_ENABLED", "OIDC_LOGOUT_REDIRECT_URL", "OIDC_PROVIDER_GOOGLE_CLIENT_ID", "OIDC_PROVIDER_GOOGLE_CLIENT_SECRET", "OIDC_PROVIDER_GOOGLE_MAPPING_CLAIM", "OIDC_PROVIDER_GOOGLE_REDIRECT_URI", "OIDC_PROVIDER_WSO2_CLIENT_ID", "OIDC_PROVIDER_WSO2_CLIENT_SECRET", "OIDC_PROVIDER_WSO2_MAPPING_CLAIM", "OIDC_PROVIDER_WSO2_SERVER_URL", "OIDC_PROVIDER_WSO2_REDIRECT_URI", "OIDC_PROVIDER_WSO2_DISPLAY_ALIAS", "OIDC_PROVIDER_WSO2_ENABLE_LOGOUT", "SLOW_QUERY_LOGGING_THRESHOLD_TIME_MS", "ENABLE_QUERY_LOGGING", "METHOD_QUERY_LOGGING_ENABLED", "ELAPSED_TIME_QUERY_LOGGING_ENABLED", "DB_POOL_TYPE", "ACTIVE_READ_REPLICAS", "AUDIT_ENABLED", "TRACKER_IMPORT_PREHEAT_CACHE_ENABLED", "ENABLE_OAUTH2_AUTHORIZATION_SERVER", "ENABLE_JWT_OIDC_TOKEN_AUTHENTICATION", "DEBEZIUM_ENABLED", "DEBEZIUM_CONNECTION_USERNAME", "DEBEZIUM_CONNECTION_PASSWORD", "DEBEZIUM_DB_HOSTNAME", "DEBEZIUM_DB_PORT", "DEBEZIUM_DB_NAME", "DEBEZIUM_SLOT_NAME", "DEBEZIUM_EXCLUDE_LIST", "DEBEZIUM_SHUTDOWN_ON_CONNECTOR_STOP", "ENABLE_API_TOKEN_AUTHENTICATION" ]
}
googleAccessToken
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access_token" : {
"type" : "string"
},
"client_id" : {
"type" : "string"
},
"expires_in" : {
"type" : "integer"
}
}
}
errorCode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "E1000", "E1001", "E1002", "E1100", "E1101", "E1102", "E1103", "E1104", "E1105", "E1106", "E1107", "E1500", "E1501", "E1502", "E1503", "E1504", "E1510", "E1511", "E1512", "E1513", "E1514", "E1515", "E1516", "E1520", "E1521", "E1522", "E1523", "E2000", "E2001", "E2002", "E2003", "E2004", "E2005", "E2006", "E2007", "E2008", "E2009", "E2010", "E2011", "E2012", "E2013", "E2014", "E2015", "E2016", "E2017", "E2018", "E2019", "E2020", "E2021", "E2022", "E2023", "E2024", "E2025", "E2026", "E2027", "E2028", "E2029", "E2030", "E2031", "E2032", "E2033", "E2034", "E2035", "E2036", "E2037", "E2038", "E2200", "E2201", "E2202", "E2203", "E2204", "E2205", "E2206", "E2207", "E2208", "E2300", "E2301", "E3000", "E3001", "E3002", "E3003", "E3004", "E3005", "E3006", "E3008", "E3009", "E3010", "E3011", "E3012", "E3013", "E3014", "E3015", "E3016", "E3017", "E3018", "E4000", "E4001", "E4002", "E4003", "E4004", "E4005", "E4006", "E4007", "E4008", "E4009", "E4010", "E4011", "E4012", "E4013", "E4014", "E4015", "E4016", "E4017", "E4018", "E4019", "E4020", "E4021", "E4022", "E4023", "E4024", "E4025", "E4026", "E4027", "E4028", "E4029", "E4030", "E4033", "E4034", "E4035", "E4036", "E4037", "E4038", "E4039", "E4040", "E4041", "E4042", "E4043", "E4044", "E4045", "E4046", "E4047", "E4048", "E4049", "E4050", "E4051", "E4052", "E4053", "E4300", "E4301", "E4302", "E4303", "E4304", "E4305", "E4306", "E4307", "E4308", "E4309", "E4310", "E4311", "E4312", "E4313", "E5000", "E5001", "E5002", "E5003", "E5004", "E5005", "E5006", "E6000", "E6001", "E6100", "E6101", "E6200", "E7000", "E7003", "E7004", "E7005", "E7006", "E7007", "E7010", "E7100", "E7101", "E7102", "E7103", "E7104", "E7105", "E7106", "E7107", "E7108", "E7109", "E7110", "E7111", "E7112", "E7113", "E7114", "E7115", "E7116", "E7117", "E7118", "E7119", "E7120", "E7121", "E7122", "E7123", "E7124", "E7125", "E7126", "E7127", "E7128", "E7129", "E7130", "E7131", "E7132", "E7133", "E7200", "E7201", "E7202", "E7203", "E7204", "E7205", "E7206", "E7207", "E7208", "E7209", "E7210", "E7211", "E7212", "E7213", "E7214", "E7215", "E7216", "E7217", "E7218", "E7219", "E7220", "E7221", "E7222", "E7223", "E7224", "E7225", "E7226", "E7227", "E7228", "E7229", "E7300", "E7301", "E7400", "E7500", "E7501", "E7502", "E7503", "E7600", "E7601", "E7602", "E7603", "E7604", "E7610", "E7611", "E7612", "E7613", "E7614", "E7615", "E7616", "E7617", "E7618", "E7619", "E7620", "E7621", "E7630", "E7631", "E7632", "E7633", "E7634", "E7635", "E7636", "E7637", "E7638", "E7639", "E7640", "E7641", "E7642", "E7643", "E7644", "E7645" ]
}
errorReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"errorKlass" : {
"type" : "string"
},
"errorProperties" : {
"type" : "array",
"items" : { }
},
"errorProperty" : {
"type" : "string"
},
"mainId" : {
"type" : "string"
},
"mainKlass" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"value" : { }
}
}
objectReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"displayName" : {
"type" : "string"
},
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"index" : {
"type" : "integer"
},
"klass" : {
"type" : "string"
},
"uid" : {
"type" : "string"
}
}
}
stats
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "integer"
},
"deleted" : {
"type" : "integer"
},
"ignored" : {
"type" : "integer"
},
"total" : {
"type" : "integer"
},
"updated" : {
"type" : "integer"
}
}
}
status
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OK", "WARNING", "ERROR" ]
}
typeReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"klass" : {
"type" : "string"
},
"objectReports" : {
"type" : "array",
"items" : {
"$ref" : "objectReport.json"
}
},
"stats" : {
"$ref" : "stats.json"
}
}
}
defaults
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCLUDE", "EXCLUDE" ]
}
fieldMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
externalFileResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accessToken" : {
"type" : "string"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"expires" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fileResource" : {
"$ref" : "fileResource.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
fileResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"contentLength" : {
"type" : "integer"
},
"contentMd5" : {
"type" : "string"
},
"contentType" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"domain" : {
"$ref" : "fileResourceDomain.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hasMultipleStorageFiles" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"storageStatus" : {
"$ref" : "fileResourceStorageStatus.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
fileResourceDomain
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_VALUE", "PUSH_ANALYSIS", "DOCUMENT", "MESSAGE_ATTACHMENT", "USER_AVATAR", "ORG_UNIT" ]
}
fileResourceRetentionStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "THREE_MONTHS", "ONE_YEAR", "FOREVER" ]
}
fileResourceStorageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "PENDING", "FAILED", "STORED" ]
}
imageFileDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SMALL", "MEDIUM", "LARGE", "ORIGINAL" ]
}
simpleImageResource
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"images" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
}
}
gistAutoType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "XL", "L", "M", "S", "XS" ]
}
idObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"nextPage" : {
"type" : "string"
},
"page" : {
"type" : "integer"
},
"pageCount" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"prevPage" : {
"type" : "string"
},
"total" : {
"type" : "integer"
}
}
}
gistQuery
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absoluteUrls" : {
"type" : "boolean"
},
"anyFilter" : {
"type" : "boolean"
},
"auto" : {
"$ref" : "gistAutoType.json"
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "field.json"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "filter.json"
}
},
"headless" : {
"type" : "boolean"
},
"inverse" : {
"type" : "boolean"
},
"orders" : {
"type" : "array",
"items" : {
"$ref" : "order.json"
}
},
"pageOffset" : {
"type" : "integer"
},
"pageSize" : {
"type" : "integer"
},
"total" : {
"type" : "boolean"
},
"translate" : {
"type" : "boolean"
}
}
}
comparison
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NULL", "NOT_NULL", "EQ", "IEQ", "NE", "LT", "LE", "GT", "GE", "IN", "NOT_IN", "EMPTY", "NOT_EMPTY", "LIKE", "NOT_LIKE", "STARTS_LIKE", "NOT_STARTS_LIKE", "ENDS_LIKE", "NOT_ENDS_LIKE", "ILIKE", "NOT_ILIKE", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "CAN_READ", "CAN_WRITE", "CAN_DATA_READ", "CAN_DATA_WRITE", "CAN_ACCESS" ]
}
direction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC" ]
}
field
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"alias" : {
"type" : "string"
},
"attribute" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"propertyPath" : {
"type" : "string"
},
"transformation" : {
"$ref" : "transform.json"
},
"transformationArgument" : {
"type" : "string"
},
"translate" : {
"type" : "boolean"
}
}
}
fieldBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"alias(String)" : {
"$ref" : "#"
},
"attribute(boolean)" : {
"$ref" : "#"
},
"propertyPath(String)" : {
"$ref" : "#"
},
"transformation(Transform)" : {
"$ref" : "#"
},
"transformationArgument(String)" : {
"$ref" : "#"
},
"translate(boolean)" : {
"$ref" : "#"
}
}
}
filter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"type" : "boolean"
},
"group" : {
"type" : "integer"
},
"operator" : {
"$ref" : "comparison.json"
},
"propertyPath" : {
"type" : "string"
},
"value" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
gistQueryBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absoluteUrls(boolean)" : {
"$ref" : "#"
},
"anyFilter(boolean)" : {
"$ref" : "#"
},
"auto(GistAutoType)" : {
"$ref" : "#"
},
"fields(List<Field>)" : {
"$ref" : "#"
},
"filters(List<Filter>)" : {
"$ref" : "#"
},
"headless(boolean)" : {
"$ref" : "#"
},
"inverse(boolean)" : {
"$ref" : "#"
},
"orders(List<Order>)" : {
"$ref" : "#"
},
"pageOffset(int)" : {
"$ref" : "#"
},
"pageSize(int)" : {
"$ref" : "#"
},
"total(boolean)" : {
"$ref" : "#"
},
"translate(boolean)" : {
"$ref" : "#"
}
}
}
order
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"direction" : {
"$ref" : "direction.json"
},
"propertyPath" : {
"type" : "string"
}
}
}
orderBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"direction(Direction)" : {
"$ref" : "#"
},
"propertyPath(String)" : {
"$ref" : "#"
}
}
}
i18nLocale
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"locale" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
icon
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "_2G", "_3G", "_4X4", "AGRICULTURE", "AGRICULTURE_WORKER", "ALERT", "ALERT_CIRCLE", "ALERT_TRIANGLE", "AMBULANCE", "AMBULATORY_CLINIC", "ANCV", "BABY_FEMALE_0203M", "BABY_FEMALE_0306M", "BABY_FEMALE_0609M", "BABY_MALE_0203M", "BABY_MALE_0306M", "BABY_MALE_0609M", "BASIC_MOTORCYCLE", "BIKE", "BILLS", "BLISTER_PILLS_OVAL_X1", "BLISTER_PILLS_OVAL_X14", "BLISTER_PILLS_OVAL_X16", "BLISTER_PILLS_OVAL_X4", "BLISTER_PILLS_ROUND_X1", "BLISTER_PILLS_ROUND_X14", "BLISTER_PILLS_ROUND_X16", "BLISTER_PILLS_ROUND_X4", "BLOOD_A_N", "BLOOD_A_P", "BLOOD_AB_N", "BLOOD_AB_P", "BLOOD_B_N", "BLOOD_B_P", "BLOOD_O_N", "BLOOD_O_P", "BLOOD_PRESSURE", "BLOOD_PRESSURE_2", "BLOOD_PRESSURE_MONITOR", "BLOOD_RH_N", "BLOOD_RH_P", "BOY_0105Y", "BOY_1015Y", "BREEDING_SITES", "CALENDAR", "CARDIOGRAM", "CARDIOGRAM_E", "CERVICAL_CANCER", "CHILD_CARE", "CHILD_PROGRAM", "CHILLS", "CHOLERA", "CHURCH", "CIRCLE_LARGE", "CIRCLE_MEDIUM", "CIRCLE_SMALL", "CITY", "CITY_WORKER", "CLEAN_HANDS", "CLINICAL_A", "CLINICAL_F", "CLINICAL_FE", "COINS", "COLD_CHAIN", "COMMUNICATION", "CONE_TEST_ON_NETS", "CONE_TEST_ON_WALLS", "CONSTRUCTION", "CONSTRUCTION_WORKER", "CONTACT_SUPPORT", "CONTRACEPTIVE_DIAPHRAGM", "CONTRACEPTIVE_INJECTION", "CONTRACEPTIVE_PATCH", "CONTRACEPTIVE_VOUCHER", "COPPER_IUD", "COUGHING", "CREDIT_CARD", "CROSS_COUNTRY_MOTORCYCLE", "DEFAULT", "DHIS2_LOGO", "DIARRHEA", "DISCRIMINATING_CONCENTRATION_BIOASSAYS", "DOCTOR", "DOMESTIC_WORKER", "DONKEY", "DRONE", "ECO_CARE", "ELDERLY", "ELECTRICITY", "EMERGENCY_POST", "EXPECTORATE", "FACTORY_WORKER", "FAMILY_PLANNING", "FEMALE_AND_MALE", "FEMALE_CONDOM", "FEMALE_SEX_WORKER", "FETUS", "FEVER", "FEVER_2", "FEVER_CHILLS", "FOREST", "FOREST_PERSONS", "FORUM", "GIRL_0105Y", "GIRL_1015Y", "GROUP_DISCUSSION_MEETING", "GROUP_DISCUSSION_MEETINGX3", "HAPPY", "HAZARDOUS", "HEADACHE", "HEALTH_WORKER", "HEALTH_WORKER_FORM", "HEART", "HEART_CARDIOGRAM", "HELICOPTER", "HIGH_BARS", "HIGH_LEVEL", "HIV_IND", "HIV_NEG", "HIV_POS", "HIV_SELF_TEST", "HOME", "HORMONAL_RING", "HOSPITAL", "HOSPITALIZED", "HOT_MEAL", "HPV", "I_CERTIFICATE_PAPER", "I_DOCUMENTS_ACCEPTED", "I_DOCUMENTS_DENIED", "I_EXAM_MULTIPLE_CHOICE", "I_EXAM_QUALIFICATION", "I_GROUPS_PERSPECTIVE_CROWD", "I_NOTE_ACTION", "I_SCHEDULE_SCHOOL_DATE_TIME", "I_TRAINING_CLASS", "I_UTENSILS", "IMM", "IMPLANT", "INFO", "INFORMATION_CAMPAIGN", "INPATIENT", "INSECTICIDE_RESISTANCE", "INTENSITY_CONCENTRATION_BIOASSAYS", "IUD", "JUSTICE", "LACTATION", "LETRINA", "LLIN", "LOW_BARS", "LOW_LEVEL", "MACHINERY", "MAGNIFYING_GLASS", "MALARIA_MIXED_MICROSCOPE", "MALARIA_NEGATIVE_MICROSCOPE", "MALARIA_OUTBREAK", "MALARIA_PF_MICROSCOPE", "MALARIA_PV_MICROSCOPE", "MALARIA_TESTING", "MALE_AND_FEMALE", "MALE_CONDOM", "MALE_SEX_WORKER", "MAN", "MARKET_STALL", "MASK", "MEASLES", "MEDICINES", "MEDIUM_BARS", "MEDIUM_LEVEL", "MEGAPHONE", "MENTAL_DISORDERS", "MICROSCOPE", "MILITARY_WORKER", "MINER_WORKER", "MOBILE_CLINIC", "MONEY_BAG", "MOSQUITO", "MOSQUITO_COLLECTION", "MSM", "NAUSEA", "NEGATIVE", "NETWORK_4G", "NETWORK_5G", "NEUROLOGY", "NEUTRAL", "NO", "NOT_OK", "NURSE", "OBSERVATION", "ODONTOLOGY", "ODONTOLOGY_IMPLANT", "OFFICER", "OK", "OLD_MAN", "OLD_WOMAN", "ORAL_CONTRACEPTION_PILLSX21", "ORAL_CONTRACEPTION_PILLSX28", "OUTPATIENT", "OVERWEIGHT", "PALM_BRANCHES_ROOF", "PAVE_ROAD", "PEACE", "PEOPLE", "PERSON", "PHONE", "PILL_1", "PILLS_2", "PILLS_3", "PILLS_4", "PLANTATION_WORKER", "POLYGON", "POSITIVE", "PREGNANT", "PREGNANT_0812W", "PREGNANT_2426W", "PREGNANT_32W", "PREGNANT_3638W", "PRISONER", "PROPER_ROOF", "PROVIDER_FST", "PWID", "QUESTION", "QUESTION_CIRCLE", "QUESTION_TRIANGLE", "RDT_RESULT_INVALID", "RDT_RESULT_MIXED", "RDT_RESULT_MIXED_INVALID", "RDT_RESULT_MIXED_INVALID_RECTANGULAR", "RDT_RESULT_MIXED_RECTANGULAR", "RDT_RESULT_NEG", "RDT_RESULT_NEG_INVALID", "RDT_RESULT_NEG_INVALID_RECTANGULAR", "RDT_RESULT_NEG_RECTANGULAR", "RDT_RESULT_NEGATIVE", "RDT_RESULT_NO_TEST", "RDT_RESULT_OUT_STOCK", "RDT_RESULT_PF", "RDT_RESULT_PF_INVALID", "RDT_RESULT_PF_INVALID_RECTANGULAR", "RDT_RESULT_PF_RECTANGULAR", "RDT_RESULT_POSITIVE", "RDT_RESULT_PV", "RDT_RESULT_PV_INVALID", "RDT_RESULT_PV_INVALID_RECTANGULAR", "RDT_RESULT_PV_RECTANGULAR", "REFERRAL", "REFUSED", "RIBBON", "RMNH", "RUNNING_WATER", "RURAL_POST", "SAD", "SANITIZER", "SAYANA_PRESS", "SECURITY_WORKER", "SEXUAL_REPRODUCTIVE_HEALTH", "SMALL_PLANE", "SOCIAL_DISTANCING", "SPRAYING", "SQUARE_LARGE", "SQUARE_MEDIUM", "SQUARE_SMALL", "STAR_LARGE", "STAR_MEDIUM", "STAR_SMALL", "STETHOSCOPE", "STI", "STOCK_OUT", "STOP", "SURGICAL_STERILIZATION", "SWEATING", "SYMPTOM", "SYNERGIST_INSECTICIDE_BIOASSAYS", "SYRINGE", "TAC", "TB", "TRANSGENDER", "TRAUMATISM", "TRAVEL", "TREATED_WATER", "TRIANGLE_LARGE", "TRIANGLE_MEDIUM", "TRIANGLE_SMALL", "TRUCK_DRIVER", "UN_PAVE_ROAD", "UNDERWEIGHT", "VESPA_MOTORCYCLE", "VIH_AIDS", "VIRUS", "VOMITING", "WAR", "WASH_HANDS", "WATER_SANITATION", "WATER_TREATMENT", "WEIGHT", "WOLD_CARE", "WOMAN", "YES", "YOUNG_PEOPLE" ]
}
iconData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"keywords" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
importStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "UPDATE", "CREATE_AND_UPDATE", "DELETE", "SYNC", "NEW_AND_UPDATES", "NEW", "UPDATES", "DELETES" ]
}
indicator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"annualized" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"decimals" : {
"type" : "integer"
},
"denominator" : {
"type" : "string"
},
"denominatorDescription" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDenominatorDescription" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayNumeratorDescription" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"indicatorType" : {
"$ref" : "indicatorType.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"numerator" : {
"type" : "string"
},
"numeratorDescription" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroupSet" : {
"$ref" : "indicatorGroupSet.json"
},
"indicators" : {
"type" : "array",
"items" : {
"$ref" : "indicator.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"indicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "indicatorGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
indicatorType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"factor" : {
"type" : "integer"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"number" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
refToTypeMapping
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
interpretation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"comments" : {
"type" : "array",
"items" : {
"$ref" : "interpretationComment.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSet" : {
"$ref" : "dataSet.json"
},
"displayName" : {
"type" : "string"
},
"eventChart" : {
"$ref" : "eventChart.json"
},
"eventReport" : {
"$ref" : "eventReport.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"likedBy" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
},
"likes" : {
"type" : "integer"
},
"map" : {
"$ref" : "map.json"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "mention.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "analyticsFavoriteType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mentions" : {
"type" : "array",
"items" : {
"$ref" : "mention.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
mention
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"username" : {
"type" : "string"
}
}
}
notificationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INTERPRETATION_CREATE", "INTERPRETATION_UPDATE", "INTERPRETATION_LIKE", "COMMENT_CREATE", "COMMENT_UPDATE" ]
}
protectionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "HIDDEN", "RESTRICTED" ]
}
keyJsonValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "string"
}
}
}
leaderNodeInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"currentNodeId" : {
"type" : "string"
},
"currentNodeUuid" : {
"type" : "string"
},
"leader" : {
"type" : "boolean"
},
"leaderNodeId" : {
"type" : "string"
},
"leaderNodeUuid" : {
"type" : "string"
}
}
}
legend
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"color" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"endValue" : {
"type" : "number"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"image" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"startValue" : {
"type" : "number"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
legendDisplayStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FIXED", "BY_DATA_ITEM" ]
}
legendDisplayStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FILL", "TEXT" ]
}
legendSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legends" : {
"type" : "array",
"items" : {
"$ref" : "legend.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"symbolizer" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
eventStatus_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
externalMapLayer
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attribution" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"imageFormat" : {
"$ref" : "imageFormat.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layers" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSetUrl" : {
"type" : "string"
},
"mapLayerPosition" : {
"$ref" : "mapLayerPosition.json"
},
"mapService" : {
"$ref" : "mapService.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PNG", "JPG" ]
}
map
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"basemap" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"latitude" : {
"type" : "number"
},
"longitude" : {
"type" : "number"
},
"mapViews" : {
"type" : "array",
"items" : {
"$ref" : "mapView.json"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"title" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"zoom" : {
"type" : "integer"
}
}
}
mapLayerPosition
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BASEMAP", "OVERLAY" ]
}
mapService
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WMS", "TMS", "XYZ" ]
}
mapView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"areaRadius" : {
"type" : "integer"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"classes" : {
"type" : "integer"
},
"code" : {
"type" : "string"
},
"colorHigh" : {
"type" : "string"
},
"colorLow" : {
"type" : "string"
},
"colorScale" : {
"type" : "string"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"config" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"eventClustering" : {
"type" : "boolean"
},
"eventCoordinateField" : {
"type" : "string"
},
"eventPointColor" : {
"type" : "string"
},
"eventPointRadius" : {
"type" : "integer"
},
"eventStatus" : {
"$ref" : "eventStatus_.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"followUp" : {
"type" : "boolean"
},
"formName" : {
"type" : "string"
},
"hidden" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"labelFontColor" : {
"type" : "string"
},
"labelFontSize" : {
"type" : "string"
},
"labelFontStyle" : {
"type" : "string"
},
"labelFontWeight" : {
"type" : "string"
},
"labels" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"layer" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"method" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"noDataColor" : {
"type" : "string"
},
"opacity" : {
"type" : "number"
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitColor" : {
"type" : "string"
},
"organisationUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnitSelectionMode" : {
"$ref" : "organisationUnitSelectionMode.json"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"parentGraph" : {
"type" : "string"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"parentLevel" : {
"type" : "integer"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStatus" : {
"$ref" : "programStatus.json"
},
"publicAccess" : {
"type" : "string"
},
"radiusHigh" : {
"type" : "integer"
},
"radiusLow" : {
"type" : "integer"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"renderingStrategy" : {
"$ref" : "mapViewRenderingStrategy.json"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"styleDataItem" : { },
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"thematicMapType" : {
"$ref" : "thematicMapType.json"
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
}
}
}
mapViewRenderingStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SINGLE", "SPLIT_BY_PERIOD", "TIMELINE" ]
}
thematicMapType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CHOROPLETH", "BUBBLE" ]
}
message
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "fileResource.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"internal" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"metaData" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sender" : {
"$ref" : "user.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
messageConversation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"assignee" : {
"$ref" : "user.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followUp" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastMessage" : {
"type" : "string",
"format" : "date-time"
},
"lastSender" : {
"$ref" : "user.json"
},
"lastSenderFirstname" : {
"type" : "string"
},
"lastSenderSurname" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageCount" : {
"type" : "integer"
},
"messageType" : {
"$ref" : "messageType_.json"
},
"messages" : {
"type" : "array",
"items" : {
"$ref" : "message.json"
}
},
"name" : {
"type" : "string"
},
"priority" : {
"$ref" : "messageConversationPriority.json"
},
"publicAccess" : {
"type" : "string"
},
"read" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "messageConversationStatus.json"
},
"subject" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userFirstname" : {
"type" : "string"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userMessages" : {
"type" : "array",
"items" : {
"$ref" : "userMessage.json"
}
},
"userSurname" : {
"type" : "string"
}
}
}
messageConversationPriority
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "LOW", "MEDIUM", "HIGH" ]
}
messageConversationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "OPEN", "PENDING", "INVALID", "SOLVED" ]
}
messageType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PRIVATE", "SYSTEM", "VALIDATION_RESULT", "TICKET" ]
}
userMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"followUp" : {
"type" : "boolean"
},
"key" : {
"type" : "string"
},
"read" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hashCode" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"importDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "versionType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
versionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BEST_EFFORT", "ATOMIC" ]
}
minMaxDataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElement" : {
"$ref" : "dataElement.json"
},
"generated" : {
"type" : "boolean"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"optionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"source" : {
"$ref" : "organisationUnit.json"
}
}
}
minMaxValueParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataSets" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnit" : {
"type" : "string"
}
}
}
nodeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SIMPLE", "COMPLEX", "COLLECTION" ]
}
preset
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ID", "CODE", "ID_NAME", "ALL", "IDENTIFIABLE", "NAMEABLE" ]
}
include
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALWAYS", "NON_NULL", "NON_EMPTY" ]
}
include
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALWAYS", "NON_NULL", "NON_EMPTY" ]
}
expressionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VARIABLE", "TRACKED_ENTITY_ATTRIBUTE", "DATA_ELEMENT" ]
}
sendStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COLLECTIVE_SUMMARY", "SINGLE_NOTIFICATION" ]
}
externalNotificationLogEntry
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowMultiple" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastSentAt" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"notificationTemplateUid" : {
"type" : "string"
},
"notificationTriggeredBy" : {
"$ref" : "notificationTriggerEvent.json"
},
"publicAccess" : {
"type" : "string"
},
"retries" : {
"type" : "integer"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
notificationTriggerEvent
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM", "PROGRAM_STAGE", "DATA_SET", "VALIDATION_RULE" ]
}
option
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"optionGroups" : {
"type" : "array",
"items" : {
"$ref" : "optionGroup.json"
}
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
optionSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"options" : {
"type" : "array",
"items" : {
"$ref" : "option.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
},
"version" : {
"type" : "integer"
}
}
}
featureType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "MULTI_POLYGON", "POLYGON", "POINT", "SYMBOL" ]
}
organisationUnit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"address" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"ancestors" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"children" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"closedDate" : {
"type" : "string",
"format" : "date-time"
},
"code" : {
"type" : "string"
},
"comment" : {
"type" : "string"
},
"contactPerson" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataSets" : {
"type" : "array",
"items" : {
"$ref" : "dataSet.json"
}
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"image" : {
"$ref" : "fileResource.json"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leaf" : {
"type" : "boolean"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"level" : {
"type" : "integer",
"readOnly" : true
},
"memberCount" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"openingDate" : {
"type" : "string",
"format" : "date-time"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"parent" : {
"$ref" : "#"
},
"path" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"phoneNumber" : {
"type" : "string"
},
"programs" : {
"type" : "array",
"items" : {
"$ref" : "program.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
organisationUnitGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"color" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"geometry" : {
"$ref" : "geometry.json"
},
"groupSets" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSet.json"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"symbol" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
organisationUnitGroupSet
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"allItems" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataDimension" : {
"type" : "boolean"
},
"dataDimensionType" : {
"$ref" : "dataDimensionType.json"
},
"description" : {
"type" : "string"
},
"dimension" : {
"type" : "string"
},
"dimensionItemKeywords" : {
"$ref" : "dimensionItemKeywords.json"
},
"dimensionType" : {
"$ref" : "dimensionType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"includeSubhierarchyInAnalytics" : {
"type" : "boolean"
},
"items" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalItemObject.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"name" : {
"type" : "string"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
organisationUnitGroupSetDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"organisationUnitGroupSet" : {
"$ref" : "organisationUnitGroupSet.json"
},
"organisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
}
}
}
organisationUnitLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"level" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"offlineLevels" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
batchResponseStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"summaries" : {
"type" : "array",
"items" : {
"$ref" : "outboundMessageResponseSummary.json"
}
}
}
}
outboundMessageBatchStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COMPLETED", "FAILED", "PENDING", "ABORTED" ]
}
outboundMessageResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"async" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"ok" : {
"type" : "boolean"
},
"status" : {
"type" : "string"
}
}
}
outboundMessageResponseSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"batchType" : {
"$ref" : "deliveryChannel.json"
},
"errorMessage" : {
"type" : "string"
},
"failed" : {
"type" : "integer"
},
"pending" : {
"type" : "integer"
},
"responseMessage" : {
"type" : "string"
},
"sent" : {
"type" : "integer"
},
"status" : {
"$ref" : "outboundMessageBatchStatus.json"
},
"total" : {
"type" : "integer"
}
}
}
order_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "MEAN_ABS_DEV", "Z_SCORE" ]
}
orgUnitSelection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DESCENDANTS", "SELECTED" ]
}
outlierDetectionAlgorithm
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "Z_SCORE", "MIN_MAX", "MOD_Z_SCORE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"algorithm" : {
"$ref" : "outlierDetectionAlgorithm.json"
},
"count" : {
"type" : "integer"
},
"dataEndDate" : {
"type" : "string",
"format" : "date-time"
},
"dataStartDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"orderBy" : {
"$ref" : "order_.json"
},
"threshold" : {
"type" : "number"
}
}
}
outlierDetectionQuery
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"algorithm" : {
"$ref" : "outlierDetectionAlgorithm.json"
},
"dataEndDate" : {
"type" : "string",
"format" : "date-time"
},
"dataStartDate" : {
"type" : "string",
"format" : "date-time"
},
"de" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"ds" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"maxResults" : {
"type" : "integer"
},
"orderBy" : {
"$ref" : "order_.json"
},
"ou" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"threshold" : {
"type" : "number"
}
}
}
outlierDetectionResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"metadata" : {
"$ref" : "outlierDetectionMetadata.json"
},
"outlierValues" : {
"type" : "array",
"items" : {
"$ref" : "outlierValue.json"
}
}
}
}
outlierValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"absDev" : {
"type" : "number"
},
"aoc" : {
"type" : "string"
},
"aocName" : {
"type" : "string"
},
"coc" : {
"type" : "string"
},
"cocName" : {
"type" : "string"
},
"de" : {
"type" : "string"
},
"deName" : {
"type" : "string"
},
"followup" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lowerBound" : {
"type" : "number"
},
"mean" : {
"type" : "number"
},
"median" : {
"type" : "number"
},
"ou" : {
"type" : "string"
},
"ouName" : {
"type" : "string"
},
"pe" : {
"type" : "string"
},
"stdDev" : {
"type" : "number"
},
"upperBound" : {
"type" : "number"
},
"value" : {
"type" : "number"
},
"zScore" : {
"type" : "number"
}
}
}
mutation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"operation" : {
"$ref" : "operation.json"
},
"path" : {
"type" : "string"
},
"value" : { }
}
}
operation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ADDITION", "DELETION" ]
}
patch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"mutations" : {
"type" : "array",
"items" : {
"$ref" : "mutation.json"
}
}
}
}
configurablePeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
period
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
periodType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
relativePeriodEnum
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TODAY", "YESTERDAY", "LAST_3_DAYS", "LAST_7_DAYS", "LAST_14_DAYS", "LAST_30_DAYS", "LAST_60_DAYS", "LAST_90_DAYS", "LAST_180_DAYS", "THIS_MONTH", "LAST_MONTH", "THIS_BIMONTH", "LAST_BIMONTH", "THIS_QUARTER", "LAST_QUARTER", "THIS_SIX_MONTH", "LAST_SIX_MONTH", "WEEKS_THIS_YEAR", "MONTHS_THIS_YEAR", "BIMONTHS_THIS_YEAR", "QUARTERS_THIS_YEAR", "THIS_YEAR", "MONTHS_LAST_YEAR", "QUARTERS_LAST_YEAR", "LAST_YEAR", "LAST_5_YEARS", "LAST_10_YEARS", "LAST_12_MONTHS", "LAST_6_MONTHS", "LAST_3_MONTHS", "LAST_6_BIMONTHS", "LAST_4_QUARTERS", "LAST_2_SIXMONTHS", "THIS_FINANCIAL_YEAR", "LAST_FINANCIAL_YEAR", "LAST_5_FINANCIAL_YEARS", "LAST_10_FINANCIAL_YEARS", "THIS_WEEK", "LAST_WEEK", "THIS_BIWEEK", "LAST_BIWEEK", "LAST_4_WEEKS", "LAST_4_BIWEEKS", "LAST_12_WEEKS", "LAST_52_WEEKS" ]
}
relativePeriods
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"biMonthsThisYear" : {
"type" : "boolean"
},
"last10FinancialYears" : {
"type" : "boolean"
},
"last10Years" : {
"type" : "boolean"
},
"last12Months" : {
"type" : "boolean"
},
"last12Weeks" : {
"type" : "boolean"
},
"last14Days" : {
"type" : "boolean"
},
"last180Days" : {
"type" : "boolean"
},
"last2SixMonths" : {
"type" : "boolean"
},
"last30Days" : {
"type" : "boolean"
},
"last3Days" : {
"type" : "boolean"
},
"last3Months" : {
"type" : "boolean"
},
"last4BiWeeks" : {
"type" : "boolean"
},
"last4Quarters" : {
"type" : "boolean"
},
"last4Weeks" : {
"type" : "boolean"
},
"last52Weeks" : {
"type" : "boolean"
},
"last5FinancialYears" : {
"type" : "boolean"
},
"last5Years" : {
"type" : "boolean"
},
"last60Days" : {
"type" : "boolean"
},
"last6BiMonths" : {
"type" : "boolean"
},
"last6Months" : {
"type" : "boolean"
},
"last7Days" : {
"type" : "boolean"
},
"last90Days" : {
"type" : "boolean"
},
"lastBiWeek" : {
"type" : "boolean"
},
"lastBimonth" : {
"type" : "boolean"
},
"lastFinancialYear" : {
"type" : "boolean"
},
"lastMonth" : {
"type" : "boolean"
},
"lastQuarter" : {
"type" : "boolean"
},
"lastSixMonth" : {
"type" : "boolean"
},
"lastWeek" : {
"type" : "boolean"
},
"lastYear" : {
"type" : "boolean"
},
"monthsLastYear" : {
"type" : "boolean"
},
"monthsThisYear" : {
"type" : "boolean"
},
"quartersLastYear" : {
"type" : "boolean"
},
"quartersThisYear" : {
"type" : "boolean"
},
"thisBiWeek" : {
"type" : "boolean"
},
"thisBimonth" : {
"type" : "boolean"
},
"thisDay" : {
"type" : "boolean"
},
"thisFinancialYear" : {
"type" : "boolean"
},
"thisMonth" : {
"type" : "boolean"
},
"thisQuarter" : {
"type" : "boolean"
},
"thisSixMonth" : {
"type" : "boolean"
},
"thisWeek" : {
"type" : "boolean"
},
"thisYear" : {
"type" : "boolean"
},
"weeksThisYear" : {
"type" : "boolean"
},
"yesterday" : {
"type" : "boolean"
}
}
}
predictor
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"annualSampleCount" : {
"type" : "integer"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"generator" : {
"$ref" : "expression.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitLevel.json"
}
},
"output" : {
"$ref" : "dataElement.json"
},
"outputCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"periodType" : {
"$ref" : "periodType.json"
},
"predictorGroups" : {
"type" : "array",
"items" : {
"$ref" : "predictorGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sampleSkipTest" : {
"$ref" : "expression.json"
},
"sequentialSampleCount" : {
"type" : "integer"
},
"sequentialSkipCount" : {
"type" : "integer"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
predictorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"predictors" : {
"type" : "array",
"items" : {
"$ref" : "predictor.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
preheatErrorReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"errorCode" : {
"$ref" : "errorCode.json"
},
"errorKlass" : {
"type" : "string"
},
"errorProperties" : {
"type" : "array",
"items" : { }
},
"errorProperty" : {
"type" : "string"
},
"mainId" : {
"type" : "string"
},
"mainKlass" : {
"type" : "string"
},
"message" : {
"type" : "string"
},
"value" : { }
}
}
preheatIdentifier
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UID", "CODE" ]
}
preheatMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "REFERENCE", "ALL", "NONE" ]
}
analyticsPeriodBoundary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"analyticsPeriodBoundaryType" : {
"$ref" : "analyticsPeriodBoundaryType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"boundaryTarget" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"offsetPeriodType" : {
"$ref" : "periodType.json"
},
"offsetPeriods" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
analyticsPeriodBoundaryType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "BEFORE_START_OF_REPORTING_PERIOD", "BEFORE_END_OF_REPORTING_PERIOD", "AFTER_START_OF_REPORTING_PERIOD", "AFTER_END_OF_REPORTING_PERIOD" ]
}
analyticsType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT" ]
}
program
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accessLevel" : {
"$ref" : "accessLevel.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"categoryCombo" : {
"$ref" : "categoryCombo.json"
},
"code" : {
"type" : "string"
},
"completeEventsExpiryDays" : {
"type" : "integer"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayEnrollmentDateLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayFrontPageList" : {
"type" : "boolean"
},
"displayIncidentDate" : {
"type" : "boolean"
},
"displayIncidentDateLabel" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"enrollmentDateLabel" : {
"type" : "string"
},
"expiryDays" : {
"type" : "integer"
},
"expiryPeriodType" : {
"$ref" : "periodType.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"ignoreOverdueEvents" : {
"type" : "boolean"
},
"incidentDateLabel" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"maxTeiCountToReturn" : {
"type" : "integer"
},
"minAttributesRequiredToSearch" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"onlyEnrollOnce" : {
"type" : "boolean"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programRuleVariables" : {
"type" : "array",
"items" : {
"$ref" : "programRuleVariable.json"
}
},
"programSections" : {
"type" : "array",
"items" : {
"$ref" : "programSection.json"
}
},
"programStages" : {
"type" : "array",
"items" : {
"$ref" : "programStage.json"
}
},
"programTrackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttribute.json"
}
},
"programType" : {
"$ref" : "programType.json"
},
"publicAccess" : {
"type" : "string"
},
"registration" : {
"type" : "boolean"
},
"relatedProgram" : {
"$ref" : "#"
},
"selectEnrollmentDatesInFuture" : {
"type" : "boolean"
},
"selectIncidentDatesInFuture" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipOffline" : {
"type" : "boolean"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"useFirstStageDuringRegistration" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"version" : {
"type" : "integer"
},
"withoutRegistration" : {
"type" : "boolean"
}
}
}
programDataElementDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programExpression
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"expression" : {
"type" : "string"
}
}
}
programIndicator
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"analyticsPeriodBoundaries" : {
"type" : "array",
"items" : {
"$ref" : "analyticsPeriodBoundary.json"
}
},
"analyticsType" : {
"$ref" : "analyticsType_.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"decimals" : {
"type" : "integer"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInForm" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filter" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"programIndicatorGroups" : {
"type" : "array",
"items" : {
"$ref" : "programIndicatorGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programIndicatorGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"completedBy" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"enrollmentDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followup" : {
"type" : "boolean"
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"incidentDate" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"messageConversations" : {
"type" : "array",
"items" : {
"$ref" : "messageConversation.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"programStageInstances" : {
"type" : "array",
"items" : {
"$ref" : "programStageInstance.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "programStatus.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityComments" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityComment.json"
}
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programOwnershipHistory
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"createdBy" : {
"type" : "string"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"entityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
}
}
}
programSection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttribute.json"
}
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowGenerateNextVisit" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"autoGenerateEvent" : {
"type" : "boolean"
},
"blockEntryForm" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataEntryForm" : {
"$ref" : "dataEntryForm.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayDueDateLabel" : {
"type" : "string"
},
"displayExecutionDateLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayGenerateEventBox" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"dueDateLabel" : {
"type" : "string"
},
"enableUserAssignment" : {
"type" : "boolean"
},
"executionDateLabel" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"formType" : {
"$ref" : "formType.json"
},
"generatedByEnrollmentDate" : {
"type" : "boolean"
},
"hideDueDate" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"minDaysFromStart" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"nextScheduleDate" : {
"$ref" : "dataElement.json"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "programNotificationTemplate.json"
}
},
"openAfterEnrollment" : {
"type" : "boolean"
},
"periodType" : {
"$ref" : "periodType.json"
},
"preGenerateUID" : {
"type" : "boolean"
},
"program" : {
"$ref" : "program.json"
},
"programStageDataElements" : {
"type" : "array",
"items" : {
"$ref" : "programStageDataElement.json"
}
},
"programStageSections" : {
"type" : "array",
"items" : {
"$ref" : "programStageSection.json"
}
},
"publicAccess" : {
"type" : "string"
},
"remindCompleted" : {
"type" : "boolean"
},
"repeatable" : {
"type" : "boolean"
},
"reportDateToUse" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"standardInterval" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationStrategy" : {
"$ref" : "validationStrategy.json"
}
}
}
programStageDataElement
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowFutureDate" : {
"type" : "boolean"
},
"allowProvidedElsewhere" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayInReports" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"renderOptionsAsRadio" : {
"type" : "boolean"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skipAnalytics" : {
"type" : "boolean"
},
"skipSynchronization" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"assignedUser" : {
"$ref" : "user.json"
},
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"comments" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityComment.json"
}
},
"completed" : {
"type" : "boolean"
},
"completedBy" : {
"type" : "string"
},
"completedDate" : {
"type" : "string",
"format" : "date-time"
},
"creatableInSearchScope" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"dueDate" : {
"type" : "string",
"format" : "date-time"
},
"eventDataValues" : {
"type" : "array",
"items" : {
"$ref" : "eventDataValue.json"
}
},
"eventDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"messageConversations" : {
"type" : "array",
"items" : {
"$ref" : "messageConversation.json"
}
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "eventStatus.json"
},
"storedBy" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageSection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElements" : {
"type" : "array",
"items" : {
"$ref" : "dataElement.json"
}
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programIndicators" : {
"type" : "array",
"items" : {
"$ref" : "programIndicator.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
programTempOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"reason" : {
"type" : "string"
},
"user" : {
"$ref" : "user.json"
},
"validTill" : {
"type" : "string",
"format" : "date-time"
}
}
}
programTempOwnershipAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"accessedBy" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"reason" : {
"type" : "string"
}
}
}
programTrackedEntityAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowFutureDate" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayInList" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"programTrackedEntityAttributeGroups" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttributeGroup.json"
}
},
"publicAccess" : {
"type" : "string"
},
"renderOptionsAsRadio" : {
"type" : "boolean"
},
"renderType" : {
"$ref" : "deviceRenderTypeMap.json"
},
"searchable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sortOrder" : {
"type" : "integer"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
programTrackedEntityAttributeDimensionItem
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programTrackedEntityAttributeGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "programTrackedEntityAttribute.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"uniqunessType" : {
"$ref" : "uniqunessType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WITH_REGISTRATION", "WITHOUT_REGISTRATION" ]
}
uniqunessType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "STRICT", "VALIDATION" ]
}
userInfoSnapshot
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"firstName" : {
"type" : "string"
},
"surname" : {
"type" : "string"
},
"uid" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
}
}
validationStrategy
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ON_COMPLETE", "ON_UPDATE_AND_INSERT" ]
}
programMessage
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageStatus" : {
"$ref" : "programMessageStatus.json"
},
"name" : {
"type" : "string"
},
"notificationTemplate" : {
"type" : "string"
},
"processedDate" : {
"type" : "string",
"format" : "date-time"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"publicAccess" : {
"type" : "string"
},
"recipients" : {
"$ref" : "programMessageRecipients.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"storeCopy" : {
"type" : "boolean"
},
"subject" : {
"type" : "string"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programMessageBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deliveryChannels(Set<DeliveryChannel>)" : {
"$ref" : "#"
},
"messageStatus(ProgramMessageStatus)" : {
"$ref" : "#"
},
"notificationTemplate(String)" : {
"$ref" : "#"
},
"processedDate(Date)" : {
"$ref" : "#"
},
"programInstance(ProgramInstance)" : {
"$ref" : "#"
},
"programStageInstance(ProgramStageInstance)" : {
"$ref" : "#"
},
"recipients(ProgramMessageRecipients)" : {
"$ref" : "#"
},
"storeCopy(boolean)" : {
"$ref" : "#"
},
"subject(String)" : {
"$ref" : "#"
},
"text(String)" : {
"$ref" : "#"
}
}
}
programMessageBatch
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"programMessages" : {
"type" : "array",
"items" : {
"$ref" : "programMessage.json"
}
}
}
}
programMessageCategory
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCOMING", "OUTGOING" ]
}
programMessageRecipients
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"emailAddresses" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"phoneNumbers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
programMessageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SENT", "FAILED", "SCHEDULED", "OUTBOUND" ]
}
notificationTrigger
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ENROLLMENT", "COMPLETION", "PROGRAM_RULE", "SCHEDULED_DAYS_DUE_DATE", "SCHEDULED_DAYS_INCIDENT_DATE", "SCHEDULED_DAYS_ENROLLMENT_DATE" ]
}
programNotificationInstance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"programInstance" : {
"$ref" : "programInstance.json"
},
"programNotificationTemplateId" : {
"type" : "integer"
},
"programNotificationTemplateSnapshot" : {
"$ref" : "programNotificationTemplateSnapshot.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"publicAccess" : {
"type" : "string"
},
"scheduledAt" : {
"type" : "string",
"format" : "date-time"
},
"sentAt" : {
"type" : "string",
"format" : "date-time"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "ORGANISATION_UNIT_CONTACT", "USERS_AT_ORGANISATION_UNIT", "USER_GROUP", "PROGRAM_ATTRIBUTE", "DATA_ELEMENT", "WEB_HOOK" ]
}
programNotificationRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "ORGANISATION_UNIT_CONTACT", "USERS_AT_ORGANISATION_UNIT", "USER_GROUP", "PROGRAM_ATTRIBUTE", "DATA_ELEMENT", "WEB_HOOK" ]
}
programNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "programNotificationRecipient.json"
},
"notificationTrigger" : {
"$ref" : "notificationTrigger.json"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientDataElement" : {
"$ref" : "dataElement.json"
},
"recipientProgramAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"recipientUserGroup" : {
"$ref" : "userGroup.json"
},
"relativeScheduledDays" : {
"type" : "integer"
},
"sendRepeatable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programStageTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "PROGRAM_STAGE_NAME", "ORG_UNIT_NAME", "DUE_DATE", "DAYS_SINCE_DUE_DATE", "DAYS_UNTIL_DUE_DATE", "CURRENT_DATE", "EVENT_DATE", "PROGRAM_ID", "EVENT_ORG_UNIT_ID", "ENROLLMENT_ORG_UNIT_ID", "PROGRAM_STAGE_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programStageTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "PROGRAM_STAGE_NAME", "ORG_UNIT_NAME", "DUE_DATE", "DAYS_SINCE_DUE_DATE", "DAYS_UNTIL_DUE_DATE", "CURRENT_DATE", "EVENT_DATE", "PROGRAM_ID", "EVENT_ORG_UNIT_ID", "ENROLLMENT_ORG_UNIT_ID", "PROGRAM_STAGE_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "ORG_UNIT_NAME", "CURRENT_DATE", "ENROLLMENT_DATE", "DAYS_SINCE_ENROLLMENT_DATE", "INCIDENT_DATE", "PROGRAM_ID", "ENROLLMENT_ORG_UNIT_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PROGRAM_NAME", "ORG_UNIT_NAME", "CURRENT_DATE", "ENROLLMENT_DATE", "DAYS_SINCE_ENROLLMENT_DATE", "INCIDENT_DATE", "PROGRAM_ID", "ENROLLMENT_ORG_UNIT_ID", "ENROLLMENT_ID", "TRACKED_ENTITY_ID" ]
}
programNotificationTemplateSnapshot
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"deliveryChannels" : {
"type" : "array",
"items" : {
"$ref" : "deliveryChannel.json"
}
},
"messageTemplate" : {
"type" : "string"
},
"notificationRecipient" : {
"$ref" : "programNotificationRecipient.json"
},
"notificationTrigger" : {
"$ref" : "notificationTrigger.json"
},
"sendRepeatable" : {
"type" : "boolean"
},
"subjectTemplate" : {
"type" : "string"
}
}
}
programRule
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"condition" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"priority" : {
"type" : "integer"
},
"program" : {
"$ref" : "program.json"
},
"programRuleActions" : {
"type" : "array",
"items" : {
"$ref" : "programRuleAction.json"
}
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleAction
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"content" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"data" : {
"type" : "string"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayContent" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"location" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"option" : {
"$ref" : "option.json"
},
"optionGroup" : {
"$ref" : "optionGroup.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
},
"programRule" : {
"$ref" : "programRule.json"
},
"programRuleActionEvaluationEnvironments" : {
"type" : "array",
"items" : {
"$ref" : "programRuleActionEvaluationEnvironment.json"
}
},
"programRuleActionEvaluationTime" : {
"$ref" : "programRuleActionEvaluationTime.json"
},
"programRuleActionType" : {
"$ref" : "programRuleActionType.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"programStageSection" : {
"$ref" : "programStageSection.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"templateUid" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleActionEvaluationEnvironment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "WEB", "ANDROID" ]
}
programRuleActionEvaluationTime
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ON_DATA_ENTRY", "ON_COMPLETE", "ALWAYS" ]
}
programRuleActionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DISPLAYTEXT", "DISPLAYKEYVALUEPAIR", "HIDEFIELD", "HIDESECTION", "HIDEPROGRAMSTAGE", "ASSIGN", "SHOWWARNING", "WARNINGONCOMPLETE", "SHOWERROR", "ERRORONCOMPLETE", "CREATEEVENT", "SETMANDATORYFIELD", "SENDMESSAGE", "SCHEDULEMESSAGE", "HIDEOPTION", "SHOWOPTIONGROUP", "HIDEOPTIONGROUP" ]
}
programRuleVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"programRuleVariableSourceType" : {
"$ref" : "programRuleVariableSourceType.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"useCodeForOptionSet" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
programRuleVariableSourceType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATAELEMENT_NEWEST_EVENT_PROGRAM_STAGE", "DATAELEMENT_NEWEST_EVENT_PROGRAM", "DATAELEMENT_CURRENT_EVENT", "DATAELEMENT_PREVIOUS_EVENT", "CALCULATED_VALUE", "TEI_ATTRIBUTE" ]
}
dateFilterPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"endBuffer" : {
"type" : "integer"
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"period" : {
"$ref" : "relativePeriodEnum.json"
},
"startBuffer" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"type" : {
"$ref" : "datePeriodType.json"
}
}
}
datePeriodType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RELATIVE", "ABSOLUTE" ]
}
eventDataFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataItem" : {
"type" : "string"
},
"dateFilter" : {
"$ref" : "dateFilterPeriod.json"
},
"eq" : {
"type" : "string"
},
"ge" : {
"type" : "string"
},
"gt" : {
"type" : "string"
},
"in" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"le" : {
"type" : "string"
},
"like" : {
"type" : "string"
},
"lt" : {
"type" : "string"
}
}
}
eventQueryCriteria
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUserMode" : {
"$ref" : "assignedUserSelectionMode.json"
},
"assignedUsers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"completedDate" : {
"$ref" : "dateFilterPeriod.json"
},
"dataFilters" : {
"type" : "array",
"items" : {
"$ref" : "eventDataFilter.json"
}
},
"displayColumnOrder" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"dueDate" : {
"$ref" : "dateFilterPeriod.json"
},
"eventDate" : {
"$ref" : "dateFilterPeriod.json"
},
"events" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followUp" : {
"type" : "boolean"
},
"lastUpdatedDate" : {
"$ref" : "dateFilterPeriod.json"
},
"order" : {
"type" : "string"
},
"organisationUnit" : {
"type" : "string"
},
"ouMode" : {
"$ref" : "organisationUnitSelectionMode.json"
},
"status" : {
"$ref" : "eventStatus.json"
}
}
}
programStageInstanceFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"eventQueryCriteria" : {
"$ref" : "eventQueryCriteria.json"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"type" : "string"
},
"programStage" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
pushAnalysis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"dashboard" : {
"$ref" : "dashboard.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"message" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"title" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
schedulingFrequency
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DAILY", "WEEKLY", "MONTHLY" ]
}
direction_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASCENDING", "DESCENDING" ]
}
stringSearchMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EQUALS", "NOT_EQUALS", "ANYWHERE", "NOT_ANYWHERE", "STARTING_LIKE", "NOT_STARTING_LIKE", "LIKE", "NOT_LIKE", "ENDING_LIKE", "NOT_ENDING_LIKE" ]
}
type
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AND", "OR" ]
}
matchMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EXACT", "START", "END", "ANYWHERE" ]
}
relationship_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"from" : {
"$ref" : "relationshipItem_.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"relationshipType" : {
"$ref" : "relationshipType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"to" : {
"$ref" : "relationshipItem_.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
relationshipConstraint
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"program" : {
"$ref" : "program.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"relationshipEntity" : {
"$ref" : "relationshipEntity.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
}
}
}
relationshipEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKED_ENTITY_INSTANCE", "PROGRAM_INSTANCE", "PROGRAM_STAGE_INSTANCE" ]
}
relationshipItem_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"programInstance" : {
"$ref" : "programInstance.json"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"relationship" : {
"$ref" : "relationship_.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
relationshipType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"bidirectional" : {
"type" : "boolean"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayFromToName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayToFromName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fromConstraint" : {
"$ref" : "relationshipConstraint.json"
},
"fromToName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"toConstraint" : {
"$ref" : "relationshipConstraint.json"
},
"toFromName" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
deviceRenderTypeMap
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
objectValueTypeRenderingOption
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"clazz" : {
"type" : "string"
},
"hasOptionSet" : {
"type" : "boolean"
},
"renderingTypes" : {
"type" : "array",
"items" : {
"$ref" : "valueTypeRenderingType.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
renderDevice
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DESKTOP", "MOBILE" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "JSON", "XML", "CSV" ]
}
sectionRenderingObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"$ref" : "sectionRenderingType.json"
}
}
}
sectionRenderingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "LISTING", "SEQUENTIAL", "MATRIX" ]
}
valueTypeRenderingObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"decimalPoints" : {
"type" : "integer"
},
"max" : {
"type" : "integer"
},
"min" : {
"type" : "integer"
},
"step" : {
"type" : "integer"
},
"type" : {
"$ref" : "valueTypeRenderingType.json"
}
}
}
valueTypeRenderingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DEFAULT", "DROPDOWN", "VERTICAL_RADIOBUTTONS", "HORIZONTAL_RADIOBUTTONS", "VERTICAL_CHECKBOXES", "HORIZONTAL_CHECKBOXES", "SHARED_HEADER_RADIOBUTTONS", "ICONS_AS_BUTTONS", "SPINNER", "ICON", "TOGGLE", "VALUE", "SLIDER", "LINEAR_SCALE", "AUTOCOMPLETE", "QR_CODE", "BAR_CODE" ]
}
report
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cacheStrategy" : {
"$ref" : "cacheStrategy.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"designContent" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"reportParams" : {
"$ref" : "reportingParams.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "reportType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"visualization" : {
"$ref" : "visualization.json"
}
}
}
reportType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "JASPER_REPORT_TABLE", "JASPER_JDBC", "HTML" ]
}
reservedValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"expiryDate" : {
"type" : "string",
"format" : "date-time"
},
"key" : {
"type" : "string"
},
"ownerObject" : {
"type" : "string"
},
"ownerUid" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
resourceTableType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ORG_UNIT_STRUCTURE", "DATA_SET_ORG_UNIT_CATEGORY", "CATEGORY_OPTION_COMBO_NAME", "DATA_ELEMENT_GROUP_SET_STRUCTURE", "INDICATOR_GROUP_SET_STRUCTURE", "ORG_UNIT_GROUP_SET_STRUCTURE", "CATEGORY_STRUCTURE", "DATA_ELEMENT_STRUCTURE", "PERIOD_STRUCTURE", "DATE_PERIOD_STRUCTURE", "DATA_ELEMENT_CATEGORY_OPTION_COMBO", "DATA_APPROVAL_REMAP_LEVEL", "DATA_APPROVAL_MIN_LEVEL" ]
}
itemValueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NUMBER", "DATE", "TEXT", "BOOLEAN" ]
}
ruleEngineIntent
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVALUATION", "DESCRIPTION" ]
}
gS1Elements
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "GS1_E0_IDENTIFIER", "GS1_E1_IDENTIFIER", "GS1_E2_IDENTIFIER", "GS1_E3_IDENTIFIER", "GS1_E4_IDENTIFIER", "GS1_I1_IDENTIFIER", "GS1_C1_IDENTIFIER", "GS1_e0_IDENTIFIER", "GS1_e1_IDENTIFIER", "GS1_e2_IDENTIFIER", "GS1_d2_IDENTIFIER", "GS1_Q3_IDENTIFIER", "GS1_J1_IDENTIFIER", "GS1_d1_IDENTIFIER", "GS1_Q1_IDENTIFIER", "GS1_GROUP_SEPARATOR", "SSCC", "GTIN", "CONTENT", "LOT_NUMBER", "PROD_DATE", "DUE_DATE", "PACK_DATE", "BEST_BEFORE_DATE", "SELL_BY", "EXP_DATE", "VARIANT", "SERIAL_NUMBER", "CPV", "TPX", "ADDITIONAL_ID", "CUSTOMER_PART_NUMBER", "MTO_VARIANT_NUMBER", "PCN", "SECONDARY_SERIAL", "REF_TO_SOURCE", "GDTI", "GLN_EXTENSION_COMPONENT", "GCN", "VAR_COUNT", "NET_WEIGHT_KG", "LENGTH_M", "WIDTH_M", "HEIGHT_M", "AREA_M2", "NET_VOLUME_L", "NET_VOLUME_M3", "NET_WEIGHT_LB", "LENGTH_I", "LENGTH_F", "LENGTH_Y", "WIDTH_I", "WIDTH_F", "WIDTH_Y", "HEIGHT_I", "HEIGHT_F", "HEIGHT_Y", "GROSS_WEIGHT_GF", "LENGTH_M_LOG", "WIDTH_M_LOG", "HEIGHT_M_LOG", "AREA_M2_LOG", "VOLUME_L_LOG", "VOLUME_M3_LOG", "KG_PER_M2", "GROSS_WHEIGHT_LB", "LENGTH_I_LOG", "LENGTH_F_LOG", "LENGTH_Y_LOG", "WIDTH_I_LOG", "WIDTH_F_LOG", "WIDTH_Y_LOG", "HEIGHT_I_LOG", "HEIGHT_F_LOG", "HEIGHT_Y_LOG", "AREA_I2", "AREA_F2", "AREA_Y2", "AREA_I2_LOG", "AREA_F2_LOG", "AREA_Y2_LOG", "NET_WEIGHT_T", "NET_VOLUME_OZ", "NET_VOLUME_Q", "NET_VOLUME_G", "VOLUME_Q_LOG", "VOLUME_G_LOG", "VOLUME_I3", "VOLUME_F3", "VOLUME_Y3", "VOLUME_I3_LOG", "VOLUME_F3_LOG", "VOLUME_Y3_LOG", "COUNT", "AMOUNT", "AMOUNT_ISO", "PRICE", "PRICE_ISO", "PRCNT_OFF", "PRICE_UOM", "ORDER_NUMBER", "GINC", "ROUTE", "SHIP_TO_GLOB_LOC", "BILL_TO_LOC", "PURCHASED_FROM", "SHIP_FOR_LOG", "LOC_NUMBER", "PAY_TO", "PROD_SERV_LOC", "PARTY", "SHIP_TO_POST", "SHIP_TO_POST_ISO", "ORIGIN", "COUNTRY_INITIAL_PROCESS", "COUNTRY_PROCESS", "COUNTRY_DISASSEMBLY", "COUNTRY_FULL_PROCESS", "ORIGIN_SUBDIVISION", "SHIP_TO_COMP", "SHIP_TO_NAME", "SHIP_TO_ADD1", "SHIP_TO_ADD2", "SHIP_TO_SUB", "SHIP_TO_LOCALITY", "SHIP_TO_REG", "SHIP_TO_COUNTRY", "SHIP_TO_PHONE", "RTN_TO_COMP", "RTN_TO_NAME", "RTN_TO_ADD1", "RTN_TO_ADD2", "RTN_TO_SUB", "RTN_TO_LOCALITY", "RTN_TO_REG", "RTN_TO_COUNTRY", "RTN_TO_POST", "RTN_TO_PHONE", "SRV_DESCRIPTION", "DANGEROUS_GOODS", "AUTH_LEAV", "SIG_REQUIRED", "NBEF_DEL_DT", "NAFT_DEL_DT", "REL_DATE", "NSN", "MEAT_CUT", "EXP_TIME", "ACTIVE_POTENCY", "CATCH_AREA", "FIRST_FREEZE_DATE", "HARVEST_DATE", "AQUATIC_SPECIES", "FISHING_GEAR_TYPE", "PROD_METHID", "REFURB_LOT", "FUNC_STAT", "REV_STAT", "GIAI_ASSEMBLY", "PROCESSOR_NUMBER", "UIC_EXT", "NHRN_PZN", "NHRN_CIP", "NHRN_CN", "NHRN_DRN", "NHRN_AIM", "CERT_NUMBER", "PROTOCOL", "DIMENSIONS", "CMT_NUMBER", "GRAI", "GIAI", "PRICE_PER_UNIT", "ITIP", "IBAN", "PROD_TIME", "OPTSEN", "CPID", "CPID_SERIAL", "VERSION", "GMN", "GSRN_PROVIDER", "GSRN_RECIPIENT", "SRIN", "REF_NUMBER", "ITIP_CONTENT", "COUPON_USA", "POINTS", "POSITIVE_OFFER_COUPON_USA", "PRODUCT_URL", "AGREEMENT_INTERNAL", "COMPANY_INTERNAL_1", "COMPANY_INTERNAL_2", "COMPANY_INTERNAL_3", "COMPANY_INTERNAL_4", "COMPANY_INTERNAL_5", "COMPANY_INTERNAL_6", "COMPANY_INTERNAL_7", "COMPANY_INTERNAL_8", "COMPANY_INTERNAL_9" ]
}
attributeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_ELEMENT", "TRACKED_ENTITY_ATTRIBUTE", "UNKNOWN" ]
}
status_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
status__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "SCHEDULE", "SKIPPED", "VISITED", "OVERDUE" ]
}
ruleValueType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "NUMERIC", "BOOLEAN", "DATE" ]
}
supplementaryDataKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "USER", "ANDROID_VERSION" ]
}
trackerObjectType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "EVENT", "ENROLLMENT" ]
}
triggerEnvironment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ANDROIDCLIENT", "SERVER" ]
}
jobConfiguration
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"configurable" : {
"type" : "boolean",
"readOnly" : true
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cronExpression" : {
"type" : "string"
},
"delay" : {
"type" : "integer"
},
"displayName" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"jobParameters" : {
"anyOf" : [ {
"$ref" : "analyticsJobParameters.json"
}, {
"$ref" : "continuousAnalyticsJobParameters.json"
}, {
"$ref" : "monitoringJobParameters.json"
}, {
"$ref" : "predictorJobParameters.json"
}, {
"$ref" : "pushAnalysisJobParameters.json"
}, {
"$ref" : "smsJobParameters.json"
}, {
"$ref" : "metadataSyncJobParameters.json"
}, {
"$ref" : "eventProgramsDataSynchronizationJobParameters.json"
}, {
"$ref" : "trackerProgramsDataSynchronizationJobParameters.json"
}, {
"$ref" : "dataSynchronizationJobParameters.json"
}, {
"$ref" : "disableInactiveUsersJobParameters.json"
} ]
},
"jobStatus" : {
"$ref" : "jobStatus.json"
},
"jobType" : {
"$ref" : "jobType.json"
},
"lastExecuted" : {
"type" : "string",
"readOnly" : true,
"format" : "date-time"
},
"lastExecutedStatus" : {
"$ref" : "jobStatus.json"
},
"lastRuntimeExecution" : {
"type" : "string",
"readOnly" : true
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leaderOnlyJob" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"nextExecutionTime" : {
"type" : "string",
"readOnly" : true,
"format" : "date-time"
},
"publicAccess" : {
"type" : "string"
},
"schedulingType" : {
"$ref" : "schedulingType.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userUid" : {
"type" : "string",
"readOnly" : true
}
}
}
jobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
jobStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RUNNING", "COMPLETED", "STOPPED", "SCHEDULED", "DISABLED", "FAILED", "NOT_STARTED" ]
}
jobType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DATA_STATISTICS", "DATA_INTEGRITY", "RESOURCE_TABLE", "ANALYTICS_TABLE", "CONTINUOUS_ANALYTICS_TABLE", "DATA_SYNC", "TRACKER_PROGRAMS_DATA_SYNC", "EVENT_PROGRAMS_DATA_SYNC", "FILE_RESOURCE_CLEANUP", "IMAGE_PROCESSING", "META_DATA_SYNC", "SMS_SEND", "SEND_SCHEDULED_MESSAGE", "PROGRAM_NOTIFICATIONS", "VALIDATION_RESULTS_NOTIFICATION", "CREDENTIALS_EXPIRY_ALERT", "MONITORING", "PUSH_ANALYSIS", "PREDICTOR", "DATA_SET_NOTIFICATION", "REMOVE_USED_OR_EXPIRED_RESERVED_VALUES", "TRACKER_IMPORT_JOB", "TRACKER_IMPORT_NOTIFICATION_JOB", "TRACKER_IMPORT_RULE_ENGINE_JOB", "LEADER_ELECTION", "LEADER_RENEWAL", "COMPLETE_DATA_SET_REGISTRATION_IMPORT", "DATAVALUE_IMPORT_INTERNAL", "METADATA_IMPORT", "DATAVALUE_IMPORT", "EVENT_IMPORT", "ENROLLMENT_IMPORT", "TEI_IMPORT", "DISABLE_INACTIVE_USERS", "ACCOUNT_EXPIRY_ALERT", "MOCK", "GML_IMPORT", "ANALYTICSTABLE_UPDATE", "PROGRAM_DATA_SYNC" ]
}
jobTypeInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"jobParameters" : {
"type" : "array",
"items" : {
"$ref" : "property.json"
}
},
"jobType" : {
"$ref" : "jobType.json"
},
"name" : {
"type" : "string"
},
"schedulingType" : {
"$ref" : "schedulingType.json"
}
}
}
schedulingType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CRON", "FIXED_DELAY" ]
}
analyticsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastYears" : {
"type" : "integer"
},
"skipPrograms" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipResourceTables" : {
"type" : "boolean"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
continuousAnalyticsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fullUpdateHourOfDay" : {
"type" : "integer"
},
"lastYears" : {
"type" : "integer"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
dataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
disableInactiveUsersJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"inactiveMonths" : {
"type" : "integer"
},
"reminderDaysBefore" : {
"type" : "integer"
}
},
"required" : [ "inactiveMonths" ]
}
eventProgramsDataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataValuesPageSize" : {
"type" : "integer"
},
"eventProgramPageSize" : {
"type" : "integer"
},
"trackerProgramPageSize" : {
"type" : "integer"
}
}
}
mockJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
}
}
}
monitoringJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistResults" : {
"type" : "boolean"
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
},
"sendNotifications" : {
"type" : "boolean"
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
predictorJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"predictorGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"predictors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
}
}
}
pushAnalysisJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pushAnalysis" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "pushAnalysis" ]
}
smsJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"recipientsList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"smsSubject" : {
"type" : "string"
}
}
}
trackerProgramsDataSynchronizationJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"lastYears" : {
"type" : "integer"
},
"skipPrograms" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipResourceTables" : {
"type" : "boolean"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
customJobParameters_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fullUpdateHourOfDay" : {
"type" : "integer"
},
"lastYears" : {
"type" : "integer"
},
"skipTableTypes" : {
"type" : "array",
"items" : {
"$ref" : "analyticsTableType.json"
}
}
}
}
customJobParameters__
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters___
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"inactiveMonths" : {
"type" : "integer"
},
"reminderDaysBefore" : {
"type" : "integer"
}
},
"required" : [ "inactiveMonths" ]
}
customJobParameters____
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
customJobParameters_____
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataValuesPageSize" : {
"type" : "integer"
},
"eventProgramPageSize" : {
"type" : "integer"
},
"trackerProgramPageSize" : {
"type" : "integer"
}
}
}
customJobParameters______
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"persistResults" : {
"type" : "boolean"
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
},
"sendNotifications" : {
"type" : "boolean"
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
customJobParameters_______
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"predictorGroups" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"predictors" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeEnd" : {
"type" : "integer"
},
"relativeStart" : {
"type" : "integer"
}
}
}
customJobParameters________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pushAnalysis" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"required" : [ "pushAnalysis" ]
}
customJobParameters_________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"message" : {
"type" : "string"
},
"recipientsList" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"smsSubject" : {
"type" : "string"
}
}
}
customJobParameters__________
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"pageSize" : {
"type" : "integer"
}
}
}
gistPreferences
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"included" : {
"$ref" : "include_.json"
},
"transformation" : {
"$ref" : "transform.json"
}
}
}
property
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"analyticalObject" : {
"type" : "boolean"
},
"apiEndpoint" : {
"type" : "string"
},
"attribute" : {
"type" : "boolean"
},
"cascade" : {
"type" : "string"
},
"collection" : {
"type" : "boolean"
},
"collectionName" : {
"type" : "string"
},
"collectionWrapping" : {
"type" : "boolean"
},
"constants" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"defaultValue" : { },
"description" : {
"type" : "string"
},
"embeddedObject" : {
"type" : "boolean"
},
"fieldName" : {
"type" : "string"
},
"gistPreferences" : {
"$ref" : "gistPreferences.json"
},
"href" : {
"type" : "string"
},
"i18nTranslationKey" : {
"type" : "string"
},
"identifiableObject" : {
"type" : "boolean"
},
"inverseRole" : {
"type" : "string"
},
"itemKlass" : {
"type" : "string"
},
"itemPropertyType" : {
"$ref" : "propertyType.json"
},
"klass" : {
"type" : "string"
},
"length" : {
"type" : "integer"
},
"manyToMany" : {
"type" : "boolean"
},
"manyToOne" : {
"type" : "boolean"
},
"max" : {
"type" : "number"
},
"min" : {
"type" : "number"
},
"name" : {
"type" : "string"
},
"nameableObject" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"oneToMany" : {
"type" : "boolean"
},
"oneToOne" : {
"type" : "boolean"
},
"ordered" : {
"type" : "boolean"
},
"owner" : {
"type" : "boolean"
},
"owningRole" : {
"type" : "string"
},
"persisted" : {
"type" : "boolean"
},
"propertyTransformer" : {
"type" : "boolean"
},
"propertyType" : {
"$ref" : "propertyType.json"
},
"readable" : {
"type" : "boolean"
},
"relativeApiEndpoint" : {
"type" : "string"
},
"required" : {
"type" : "boolean"
},
"simple" : {
"type" : "boolean"
},
"translatable" : {
"type" : "boolean"
},
"translationKey" : {
"type" : "string"
},
"unique" : {
"type" : "boolean"
},
"writable" : {
"type" : "boolean"
}
}
}
propertyType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "IDENTIFIER", "TEXT", "NUMBER", "INTEGER", "BOOLEAN", "EMAIL", "PASSWORD", "URL", "DATE", "PHONENUMBER", "GEOLOCATION", "COLOR", "CONSTANT", "COMPLEX", "COLLECTION", "REFERENCE" ]
}
schema
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"apiEndpoint" : {
"type" : "string"
},
"authorities" : {
"type" : "array",
"items" : {
"$ref" : "authority.json"
}
},
"collectionName" : {
"type" : "string"
},
"dataReadShareable" : {
"type" : "boolean"
},
"dataShareable" : {
"type" : "boolean"
},
"dataWriteShareable" : {
"type" : "boolean"
},
"defaultPrivate" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"embeddedObject" : {
"type" : "boolean"
},
"favoritable" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"identifiableObject" : {
"type" : "boolean"
},
"implicitPrivateAuthority" : {
"type" : "boolean"
},
"klass" : {
"type" : "string"
},
"metadata" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"nameableObject" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"order" : {
"type" : "integer"
},
"persisted" : {
"type" : "boolean"
},
"plural" : {
"type" : "string"
},
"properties" : {
"type" : "array",
"items" : {
"$ref" : "property.json"
}
},
"references" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"relativeApiEndpoint" : {
"type" : "string"
},
"secondaryMetadata" : {
"type" : "boolean"
},
"shareable" : {
"type" : "boolean"
},
"singular" : {
"type" : "string"
},
"subscribable" : {
"type" : "boolean"
},
"subscribableObject" : {
"type" : "boolean"
},
"translatable" : {
"type" : "boolean"
}
}
}
schemas
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"schemas" : {
"type" : "array",
"items" : {
"$ref" : "schema.json"
}
}
}
}
include_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FALSE", "TRUE", "AUTO" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUTO", "NONE", "IS_EMPTY", "IS_NOT_EMPTY", "SIZE", "MEMBER", "NOT_MEMBER", "IDS", "ID_OBJECTS", "PLUCK" ]
}
userDto
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
}
}
authorities
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "F_TRACKED_ENTITY_INSTANCE_SEARCH_IN_ALL_ORGUNITS", "F_TEI_CASCADE_DELETE", "F_ENROLLMENT_CASCADE_DELETE", "F_EDIT_EXPIRED", "F_IGNORE_TRACKER_REQUIRED_VALUE_VALIDATION", "F_SKIP_DATA_IMPORT_AUDIT", "F_METADATA_EXPORT", "F_USER_VIEW" ]
}
authority
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"type" : {
"$ref" : "authorityType.json"
}
}
}
authorityType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "CREATE", "DATA_CREATE", "CREATE_PUBLIC", "CREATE_PRIVATE", "EXTERNALIZE", "READ", "DATA_READ", "UPDATE", "DELETE" ]
}
recaptchaResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"challenge_ts" : {
"type" : "string"
},
"error-codes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"hostname" : {
"type" : "string"
},
"success" : {
"type" : "boolean"
}
}
}
restoreOptions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RECOVER_PASSWORD_OPTION", "INVITE_WITH_USERNAME_CHOICE", "INVITE_WITH_DEFINED_USERNAME" ]
}
restoreType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RECOVER_PASSWORD", "INVITE" ]
}
access
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"data" : {
"$ref" : "accessData.json"
},
"delete" : {
"type" : "boolean"
},
"externalize" : {
"type" : "boolean"
},
"manage" : {
"type" : "boolean"
},
"read" : {
"type" : "boolean"
},
"update" : {
"type" : "boolean"
},
"write" : {
"type" : "boolean"
}
}
}
accessData
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"read" : {
"type" : "boolean"
},
"write" : {
"type" : "boolean"
}
}
}
permission
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "READ", "WRITE", "DATA_READ", "DATA_WRITE" ]
}
apiToken
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"attributes" : {
"type" : "array",
"items" : {
"anyOf" : [ {
"$ref" : "ipAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "IpAllowedList"
}
},
"required" : [ "type" ]
}, {
"$ref" : "refererAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "RefererAllowedList"
}
},
"required" : [ "type" ]
}, {
"$ref" : "methodAllowedList.json",
"type" : "object",
"properties" : {
"type" : {
"const" : "MethodAllowedList"
}
},
"required" : [ "type" ]
} ]
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"expire" : {
"type" : "integer"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "apiTokenType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"version" : {
"type" : "integer"
}
}
}
apiTokenType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"const" : "PERSONAL_ACCESS_TOKEN"
}
oAuth2Client
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cid" : {
"type" : "string"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"grantTypes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"redirectUris" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"secret" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
settingKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "UI_LOCALE", "DB_LOCALE", "ANALYSIS_DISPLAY_PROPERTY", "ANALYSIS_DIGIT_GROUP_SEPARATOR", "CURRENT_DOMAIN_TYPE", "TRACKER_DASHBOARD_LAYOUT", "APPLICATION_TITLE", "APPLICATION_INTRO", "APPLICATION_NOTIFICATION", "APPLICATION_FOOTER", "APPLICATION_RIGHT_FOOTER", "FLAG", "FLAG_IMAGE", "START_MODULE", "START_MODULE_ENABLE_LIGHT_WEIGHT", "FACTOR_OF_DEVIATION", "EMAIL_HOST_NAME", "EMAIL_PORT", "EMAIL_USERNAME", "EMAIL_TLS", "EMAIL_SENDER", "EMAIL_PASSWORD", "MIN_PASSWORD_LENGTH", "MAX_PASSWORD_LENGTH", "SMS_CONFIG", "CACHE_STRATEGY", "CACHEABILITY", "ANALYTICS_FINANCIAL_YEAR_START", "PHONE_NUMBER_AREA_CODE", "MULTI_ORGANISATION_UNIT_FORMS", "CONFIGURATION", "ACCOUNT_RECOVERY", "LOCK_MULTIPLE_FAILED_LOGINS", "GOOGLE_ANALYTICS_UA", "CREDENTIALS_EXPIRES", "CREDENTIALS_EXPIRY_ALERT", "ACCOUNT_EXPIRES_IN_DAYS", "ACCOUNT_EXPIRY_ALERT", "SELF_REGISTRATION_NO_RECAPTCHA", "RECAPTCHA_SECRET", "RECAPTCHA_SITE", "CAN_GRANT_OWN_USER_AUTHORITY_GROUPS", "IGNORE_ANALYTICS_APPROVAL_YEAR_THRESHOLD", "ANALYTICS_MAX_LIMIT", "INCLUDE_ZERO_VALUES_IN_ANALYTICS", "SQL_VIEW_MAX_LIMIT", "RESPECT_META_DATA_START_END_DATES_IN_ANALYTICS_TABLE_EXPORT", "SKIP_DATA_TYPE_VALIDATION_IN_ANALYTICS_TABLE_EXPORT", "CUSTOM_LOGIN_PAGE_LOGO", "CUSTOM_TOP_MENU_LOGO", "ANALYTICS_MAINTENANCE_MODE", "DATABASE_SERVER_CPUS", "LAST_SUCCESSFUL_ANALYTICS_TABLES_RUNTIME", "LAST_SUCCESSFUL_LATEST_ANALYTICS_PARTITION_RUNTIME", "LAST_MONITORING_RUN", "LAST_SUCCESSFUL_DATA_VALUE_SYNC", "LAST_SUCCESSFUL_EVENT_DATA_SYNC", "LAST_SUCCESSFUL_COMPLETE_DATA_SET_REGISTRATION_SYNC", "SKIP_SYNCHRONIZATION_FOR_DATA_CHANGED_BEFORE", "LAST_SUCCESSFUL_ANALYTICS_TABLES_UPDATE", "LAST_SUCCESSFUL_LATEST_ANALYTICS_PARTITION_UPDATE", "LAST_SUCCESSFUL_RESOURCE_TABLES_UPDATE", "LAST_SUCCESSFUL_SYSTEM_MONITORING_PUSH", "LAST_SUCCESSFUL_MONITORING", "NEXT_ANALYTICS_TABLE_UPDATE", "HELP_PAGE_LINK", "ACCEPTANCE_REQUIRED_FOR_APPROVAL", "SYSTEM_NOTIFICATIONS_EMAIL", "ANALYSIS_RELATIVE_PERIOD", "REQUIRE_ADD_TO_VIEW", "ALLOW_OBJECT_ASSIGNMENT", "USE_CUSTOM_LOGO_FRONT", "USE_CUSTOM_LOGO_BANNER", "METADATA_REPO_URL", "DATA_IMPORT_STRICT_PERIODS", "DATA_IMPORT_STRICT_DATA_ELEMENTS", "DATA_IMPORT_STRICT_CATEGORY_OPTION_COMBOS", "DATA_IMPORT_STRICT_ORGANISATION_UNITS", "DATA_IMPORT_STRICT_ATTRIBUTE_OPTION_COMBOS", "DATA_IMPORT_REQUIRE_CATEGORY_OPTION_COMBO", "DATA_IMPORT_REQUIRE_ATTRIBUTE_OPTION_COMBO", "CUSTOM_JS", "CUSTOM_CSS", "CALENDAR", "DATE_FORMAT", "STYLE", "REMOTE_INSTANCE_URL", "REMOTE_INSTANCE_USERNAME", "REMOTE_INSTANCE_PASSWORD", "GOOGLE_MAPS_API_KEY", "BING_MAPS_API_KEY", "LAST_SUCCESSFUL_METADATA_SYNC", "METADATAVERSION_ENABLED", "METADATA_FAILED_VERSION", "METADATA_LAST_FAILED_TIME", "LAST_SUCCESSFUL_SCHEDULED_PROGRAM_NOTIFICATIONS", "LAST_SUCCESSFUL_SCHEDULED_DATASET_NOTIFICATIONS", "REMOTE_METADATA_VERSION", "SYSTEM_METADATA_VERSION", "STOP_METADATA_SYNC", "FILE_RESOURCE_RETENTION_STRATEGY", "MAX_REMOTE_SERVER_AVAILABILITY_CHECK_ATTEMPTS", "MAX_SYNC_ATTEMPTS", "DELAY_BETWEEN_REMOTE_SERVER_AVAILABILITY_CHECK_ATTEMPTS", "LAST_SUCCESSFUL_DATA_STATISTICS", "ANALYTICS_HIDE_DAILY_PERIODS", "ANALYTICS_HIDE_WEEKLY_PERIODS", "ANALYTICS_HIDE_BIWEEKLY_PERIODS", "ANALYTICS_HIDE_MONTHLY_PERIODS", "ANALYTICS_HIDE_BIMONTHLY_PERIODS", "GATHER_ANALYTICAL_OBJECT_STATISTICS_IN_DASHBOARD_VIEWS", "COUNT_PASSIVE_DASHBOARD_VIEWS_IN_USAGE_ANALYTICS", "DASHBOARD_CONTEXT_MENU_ITEM_SWITCH_VIEW_TYPE", "DASHBOARD_CONTEXT_MENU_ITEM_OPEN_IN_RELEVANT_APP", "DASHBOARD_CONTEXT_MENU_ITEM_SHOW_INTERPRETATIONS_AND_DETAILS", "DASHBOARD_CONTEXT_MENU_ITEM_VIEW_FULLSCREEN", "RULE_ENGINE_ASSIGN_OVERWRITE", "ANALYTICS_CACHE_PROGRESSIVE_TTL_FACTOR", "ANALYTICS_CACHE_TTL_MODE" ]
}
styleObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"path" : {
"type" : "string"
}
}
}
accessObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
cascadeSharingReport
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"countUpdatedDashboardItems" : {
"type" : "integer"
},
"errorReports" : {
"type" : "array",
"items" : {
"$ref" : "errorReport.json"
}
},
"updateObjects" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "idObject_.json"
}
}
}
}
}
cascadeSharingReportBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"countUpdatedDashboardItems(int)" : {
"$ref" : "#"
},
"errorReports(List<ErrorReport>)" : {
"$ref" : "#"
},
"updateObjects(Map<String, Set<IdObject>>)" : {
"$ref" : "#"
}
}
}
idObject_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
}
completenessMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ALL_DATAVALUE", "AT_LEAST_ONE_DATAVALUE", "DO_NOT_MARK_COMPLETE" ]
}
sMSCommand
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"codeValueSeparator" : {
"type" : "string"
},
"completenessMethod" : {
"$ref" : "completenessMethod.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"currentPeriodUsedForReporting" : {
"type" : "boolean"
},
"dataset" : {
"$ref" : "dataSet.json"
},
"defaultMessage" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"moreThanOneOrgUnitMessage" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"noUserMessage" : {
"type" : "string"
},
"parserType" : {
"$ref" : "parserType.json"
},
"program" : {
"$ref" : "program.json"
},
"programStage" : {
"$ref" : "programStage.json"
},
"publicAccess" : {
"type" : "string"
},
"receivedMessage" : {
"type" : "string"
},
"separator" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"smsCodes" : {
"type" : "array",
"items" : {
"$ref" : "sMSCode.json"
}
},
"specialCharacters" : {
"type" : "array",
"items" : {
"$ref" : "sMSSpecialCharacter.json"
}
},
"successMessage" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroup" : {
"$ref" : "userGroup.json"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"wrongFormatMessage" : {
"type" : "string"
}
}
}
sMSSpecialCharacter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
sMSCode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"code" : {
"type" : "string"
},
"compulsory" : {
"type" : "boolean"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"formula" : {
"type" : "string"
},
"optionId" : {
"type" : "integer"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
}
}
}
clickatellGatewayConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"const" : "clickatell"
}
},
"required" : [ "type" ]
}
contentType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "APPLICATION_JSON", "APPLICATION_XML", "TEXT_PLAIN", "FORM_URL_ENCODED" ]
}
genericHttpGatewayConfig
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"type" : {
"const" : "http"
}
},
"required" : [ "type" ]
}
incomingSms
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"gatewayid" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"originator" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"receiveddate" : {
"type" : "string",
"format" : "date-time"
},
"sentdate" : {
"type" : "string",
"format" : "date-time"
},
"sharing" : {
"$ref" : "sharing.json"
},
"smsencoding" : {
"$ref" : "smsMessageEncoding.json"
},
"smsstatus" : {
"$ref" : "smsMessageStatus.json"
},
"text" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
smsMessageEncoding
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ENC7BIT", "ENC8BIT", "ENCUCS2", "ENCCUSTOM" ]
}
smsMessageStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INCOMING", "PROCESSING", "UNHANDLED", "FAILED", "PROCESSED", "SENT" ]
}
relationshipDir
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FROM", "TO" ]
}
bulkSmsRecipient
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
bulkSmsRequestEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"to" : {
"type" : "array",
"items" : {
"$ref" : "bulkSmsRecipient.json"
}
}
}
}
clickatellRequestEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"content" : {
"type" : "string"
},
"to" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
clickatellResponseEntity
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
gatewayResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "SENT", "FAILED", "PENDING", "SERVICE_NOT_AVAILABLE", "ENCODING_FAILURE", "PROCESSING", "QUEUED", "NO_GATEWAY_CONFIGURATION", "NO_DEFAULT_GATEWAY", "AUTHENTICATION_FAILED", "NO_RECIPIENT", "SMS_DISABLED", "SMPP_SESSION_FAILURE", "RESULT_CODE_0", "RESULT_CODE_1", "RESULT_CODE_22", "RESULT_CODE_23", "RESULT_CODE_24", "RESULT_CODE_25", "RESULT_CODE_26", "RESULT_CODE_27", "RESULT_CODE_28", "RESULT_CODE_40", "RESULT_CODE_201", "RESULT_CODE_403", "RESULT_CODE_200", "RESULT_CODE_202", "RESULT_CODE_207", "RESULT_CODE_400", "RESULT_CODE_401", "RESULT_CODE_402", "RESULT_CODE_404", "RESULT_CODE_405", "RESULT_CODE_410", "RESULT_CODE_429", "RESULT_CODE_503", "RESULT_CODE_504" ]
}
outboundSms
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"date" : {
"type" : "string",
"format" : "date-time"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"message" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"recipients" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"sender" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"status" : {
"$ref" : "outboundSmsStatus.json"
},
"subject" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
outboundSmsStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OUTBOUND", "SENT", "ERROR", "PENDING", "SCHEDULED", "DELIVERED", "FAILED" ]
}
submissionType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SINGLE", "BATCH" ]
}
parserType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "KEY_VALUE_PARSER", "J2ME_PARSER", "ALERT_PARSER", "UNREGISTERED_PARSER", "TRACKED_ENTITY_REGISTRATION_PARSER", "PROGRAM_STAGE_DATAENTRY_PARSER", "EVENT_REGISTRATION_PARSER" ]
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "USER", "TRACKED_ENTITY_TYPE", "TRACKED_ENTITY_ATTRIBUTE", "PROGRAM", "ORGANISATION_UNIT", "DATA_ELEMENT", "CATEGORY_OPTION_COMBO", "DATASET", "PROGRAM_STAGE", "EVENT", "ENROLLMENT", "TRACKED_ENTITY_INSTANCE", "RELATIONSHIP", "RELATIONSHIP_TYPE" ]
}
smsEnrollmentStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "CANCELLED" ]
}
smsEventStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ACTIVE", "COMPLETED", "VISITED", "SCHEDULE", "OVERDUE", "SKIPPED" ]
}
submissionType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AGGREGATE_DATASET", "DELETE", "ENROLLMENT", "RELATIONSHIP", "SIMPLE_EVENT", "TRACKER_EVENT" ]
}
valueType_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INT", "FLOAT", "DATE", "BOOL", "STRING" ]
}
smsResponse
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "SUCCESS", "WARN_DVERR", "WARN_DVEMPTY", "WARN_AVEMPTY", "UNKNOWN_ERROR", "HEADER_ERROR", "READ_ERROR", "INVALID_USER", "INVALID_ORGUNIT", "INVALID_PROGRAM", "INVALID_TETYPE", "INVALID_DATASET", "INVALID_PERIOD", "INVALID_AOC", "INVALID_TEI", "INVALID_STAGE", "INVALID_EVENT", "INVALID_RELTYPE", "INVALID_ENROLL", "INVALID_ATTRIB", "USER_NOTIN_OU", "OU_NOTIN_PROGRAM", "OU_NOTIN_DATASET", "ENROLL_FAILED", "DATASET_LOCKED", "MULTI_PROGRAMS", "MULTI_STAGES", "NO_ENROLL", "NULL_ATTRIBVAL", "ENROLL_EXIST" ]
}
sqlView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"cacheStrategy" : {
"$ref" : "cacheStrategy.json"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sqlQuery" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "sqlViewType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
sqlViewType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "VIEW", "MATERIALIZED_VIEW", "QUERY" ]
}
systemJob
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "FILE_RESOURCE", "DATA_STATISTICS", "VALIDATION_RESULTS_NOTIFICATION", "CREDENTIALS_EXPIRY_ALERT", "ACCOUNT_EXPIRY_ALERT", "DATA_SET_NOTIFICATION", "REMOVE_EXPIRED_OR_USED_RESERVED_VALUES", "LEADER_ELECTION" ]
}
systemInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"buildTime" : {
"type" : "string",
"format" : "date-time"
},
"calendar" : {
"type" : "string"
},
"clusterHostname" : {
"type" : "string"
},
"contextPath" : {
"type" : "string"
},
"cpuCores" : {
"type" : "integer"
},
"databaseInfo" : {
"$ref" : "databaseInfo.json"
},
"dateFormat" : {
"type" : "string"
},
"emailConfigured" : {
"type" : "boolean"
},
"encryption" : {
"type" : "boolean"
},
"environmentVariable" : {
"type" : "string"
},
"externalDirectory" : {
"type" : "string"
},
"fileStoreProvider" : {
"type" : "string"
},
"instanceBaseUrl" : {
"type" : "string"
},
"intervalSinceLastAnalyticsTablePartitionSuccess" : {
"type" : "string"
},
"intervalSinceLastAnalyticsTableSuccess" : {
"type" : "string"
},
"isMetadataVersionEnabled" : {
"type" : "boolean"
},
"jasperReportsVersion" : {
"type" : "string"
},
"javaOpts" : {
"type" : "string"
},
"javaVendor" : {
"type" : "string"
},
"javaVersion" : {
"type" : "string"
},
"lastAnalyticsTablePartitionRuntime" : {
"type" : "string"
},
"lastAnalyticsTablePartitionSuccess" : {
"type" : "string",
"format" : "date-time"
},
"lastAnalyticsTableRuntime" : {
"type" : "string"
},
"lastAnalyticsTableSuccess" : {
"type" : "string",
"format" : "date-time"
},
"lastMetadataVersionSyncAttempt" : {
"type" : "string",
"format" : "date-time"
},
"lastSystemMonitoringSuccess" : {
"type" : "string",
"format" : "date-time"
},
"memoryInfo" : {
"type" : "string"
},
"metadataSyncEnabled" : {
"type" : "boolean"
},
"nodeId" : {
"type" : "string"
},
"osArchitecture" : {
"type" : "string"
},
"osName" : {
"type" : "string"
},
"osVersion" : {
"type" : "string"
},
"readOnlyMode" : {
"type" : "string"
},
"readReplicaCount" : {
"type" : "integer"
},
"redisEnabled" : {
"type" : "boolean"
},
"redisHostname" : {
"type" : "string"
},
"revision" : {
"type" : "string"
},
"serverDate" : {
"type" : "string",
"format" : "date-time"
},
"serverTimeZoneDisplayName" : {
"type" : "string"
},
"serverTimeZoneId" : {
"type" : "string"
},
"systemId" : {
"type" : "string"
},
"systemMetadataVersion" : {
"type" : "string"
},
"systemMonitoringUrl" : {
"type" : "string"
},
"systemName" : {
"type" : "string"
},
"userAgent" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
}
}
databaseInfo
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"databaseVersion" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"spatialSupport" : {
"type" : "boolean"
},
"url" : {
"type" : "string"
},
"user" : {
"type" : "string"
}
}
}
listGrid
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"headerWidth" : {
"type" : "integer"
},
"headers" : {
"type" : "array",
"items" : {
"$ref" : "gridHeader.json"
}
},
"height" : {
"type" : "integer"
},
"metaData" : {
"type" : "object"
},
"rows" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : { }
}
},
"subtitle" : {
"type" : "string"
},
"table" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"width" : {
"type" : "integer"
}
}
}
notification
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"category" : {
"$ref" : "jobType.json"
},
"completed" : {
"type" : "boolean"
},
"id" : {
"type" : "string"
},
"level" : {
"$ref" : "notificationLevel.json"
},
"message" : {
"type" : "string"
},
"time" : {
"type" : "string",
"format" : "date-time"
},
"uid" : {
"type" : "string"
}
}
}
notificationLevel
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OFF", "DEBUG", "INFO", "WARN", "ERROR" ]
}
textPattern
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"ownerObject" : {
"$ref" : "objects.json"
},
"ownerUid" : {
"type" : "string"
},
"segments" : {
"type" : "array",
"items" : {
"$ref" : "textPatternSegment.json"
}
}
}
}
textPatternMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TEXT", "RANDOM", "SEQUENTIAL", "ORG_UNIT_CODE", "CURRENT_DATE" ]
}
textPatternSegment
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"method" : {
"$ref" : "textPatternMethod.json"
},
"parameter" : {
"type" : "string"
}
}
}
trackedEntityAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"confidential" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInListNoProgram" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayOnVisitSchedule" : {
"type" : "boolean"
},
"displayShortName" : {
"type" : "string"
},
"expression" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"fieldMask" : {
"type" : "string"
},
"formName" : {
"type" : "string"
},
"generated" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"inherit" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"optionSet" : {
"$ref" : "optionSet.json"
},
"optionSetValue" : {
"type" : "boolean"
},
"orgunitScope" : {
"type" : "boolean"
},
"pattern" : {
"type" : "string"
},
"periodOffset" : {
"type" : "integer"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipSynchronization" : {
"type" : "boolean"
},
"sortOrderInListNoProgram" : {
"type" : "integer"
},
"sortOrderInVisitSchedule" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"unique" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
trackedEntityAttributeDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
}
}
}
trackedEntityDataElementDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"dataElement" : {
"$ref" : "dataElement.json"
},
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"programStage" : {
"$ref" : "programStage.json"
}
}
}
trackedEntityInstance_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdAtClient" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"createdByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"deleted" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"geometry" : {
"$ref" : "geometry.json"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"inactive" : {
"type" : "boolean"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedAtClient" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"lastUpdatedByUserInfo" : {
"$ref" : "userInfoSnapshot.json"
},
"name" : {
"type" : "string"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"potentialDuplicate" : {
"type" : "boolean"
},
"programInstances" : {
"type" : "array",
"items" : {
"$ref" : "programInstance.json"
}
},
"programOwners" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramOwner.json"
}
},
"publicAccess" : {
"type" : "string"
},
"relationshipItems" : {
"type" : "array",
"items" : {
"$ref" : "relationshipItem_.json"
}
},
"sharing" : {
"$ref" : "sharing.json"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityAttributeValues" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeValue.json"
}
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
orderColumn
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "TRACKEDENTITY", "CREATED", "CREATED_AT", "CREATED_AT_CLIENT", "UPDATED_AT", "UPDATED_AT_CLIENT", "ENROLLED_AT", "INACTIVE" ]
}
trackedEntityProgramIndicatorDimension
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"filter" : {
"type" : "string"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"programIndicator" : {
"$ref" : "programIndicator.json"
}
}
}
trackedEntityProgramOwner
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"program" : {
"$ref" : "program.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
}
}
}
trackedEntityType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"allowAuditLog" : {
"type" : "boolean"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"featureType" : {
"$ref" : "featureType.json"
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"maxTeiCountToReturn" : {
"type" : "integer"
},
"minAttributesRequiredToSearch" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"style" : {
"$ref" : "objectStyle.json"
},
"trackedEntityTypeAttributes" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityTypeAttribute.json"
}
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
trackedEntityTypeAttribute
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayInList" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"mandatory" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"searchable" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityType" : {
"$ref" : "trackedEntityType.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"valueType" : {
"$ref" : "valueType.json"
}
}
}
trackedEntityAttributeValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"storedBy" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"value" : {
"type" : "string"
}
}
}
trackedEntityAttributeValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"auditType" : {
"$ref" : "auditType_.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"modifiedBy" : {
"type" : "string"
},
"trackedEntityAttribute" : {
"$ref" : "trackedEntityAttribute.json"
},
"trackedEntityInstance" : {
"$ref" : "trackedEntityInstance_.json"
},
"value" : {
"type" : "string"
}
}
}
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"commentText" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"creator" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
trackedEntityDataValueAudit
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"auditType" : {
"$ref" : "auditType_.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dataElement" : {
"$ref" : "dataElement.json"
},
"modifiedBy" : {
"type" : "string"
},
"programStageInstance" : {
"$ref" : "programStageInstance.json"
},
"providedElsewhere" : {
"type" : "boolean"
},
"value" : {
"type" : "string"
}
}
}
eventFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"assignedUserMode" : {
"$ref" : "assignedUserSelectionMode.json"
},
"assignedUsers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"eventCreatedPeriod" : {
"$ref" : "filterPeriod.json"
},
"eventStatus" : {
"$ref" : "eventStatus.json"
},
"programStage" : {
"type" : "string"
}
}
}
filterPeriod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"periodFrom" : {
"type" : "integer"
},
"periodTo" : {
"type" : "integer"
}
}
}
trackedEntityInstanceFilter
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayDescription" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"enrollmentCreatedPeriod" : {
"$ref" : "filterPeriod.json"
},
"enrollmentStatus" : {
"$ref" : "programStatus.json"
},
"eventFilters" : {
"type" : "array",
"items" : {
"$ref" : "eventFilter.json"
}
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"followup" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"program" : {
"$ref" : "program.json"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"sortOrder" : {
"type" : "integer"
},
"style" : {
"$ref" : "objectStyle.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
translation
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"locale" : {
"type" : "string"
},
"property" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
translationProperty
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NAME", "SHORT_NAME", "DESCRIPTION", "FORM_NAME", "NUMERATOR_DESCRIPTION", "DENOMINATOR_DESCRIPTION", "RELATIONSHIP_FROM_TO_NAME", "RELATIONSHIP_TO_FROM_NAME", "INSTRUCTION", "INCIDENT_DATE_LABEL", "ENROLLMENT_DATE_LABEL", "EXECUTION_DATE_LABEL", "DUE_DATE_LABEL", "CONTENT" ]
}
passwordValidationError
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "PASSWORD_IS_MANDATORY", "PASSWORD_TOO_LONG_TOO_SHORT", "PASSWORD_MUST_HAVE_DIGIT", "PASSWORD_MUST_HAVE_UPPER", "PASSWORD_MUST_HAVE_SPECIAL", "PASSWORD_CONTAINS_RESERVED_WORD", "PASSWORD_CONTAINS_NAME_OR_EMAIL", "PASSWORD_ALREADY_USED_BEFORE" ]
}
user
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"avatar" : {
"$ref" : "fileResource.json"
},
"birthday" : {
"type" : "string",
"format" : "date-time"
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "#"
},
"dataViewMaxOrganisationUnitLevel" : {
"type" : "integer"
},
"dataViewOrganisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"displayName" : {
"type" : "string"
},
"education" : {
"type" : "string"
},
"email" : {
"type" : "string"
},
"employer" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"facebookMessenger" : {
"type" : "string"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"firstName" : {
"type" : "string"
},
"gender" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interests" : {
"type" : "string"
},
"introduction" : {
"type" : "string"
},
"jobTitle" : {
"type" : "string"
},
"languages" : {
"type" : "string"
},
"lastCheckedInterpretations" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "#"
},
"name" : {
"type" : "string"
},
"nationality" : {
"type" : "string"
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"phoneNumber" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"skype" : {
"type" : "string"
},
"surname" : {
"type" : "string"
},
"teiSearchOrganisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"telegram" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"twitter" : {
"type" : "string"
},
"user" : {
"$ref" : "#"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userCredentials" : {
"$ref" : "userCredentials.json"
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"welcomeMessage" : {
"type" : "string"
},
"whatsApp" : {
"type" : "string"
}
}
}
userAccess
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"userUid" : {
"type" : "string"
},
"displayName()" : {
"type" : "string"
}
}
}
userAuthorityGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"authorities" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
userCredentials
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"accountExpiry" : {
"type" : "string",
"format" : "date-time"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"catDimensionConstraints" : {
"type" : "array",
"items" : {
"$ref" : "category.json"
}
},
"code" : {
"type" : "string"
},
"cogsDimensionConstraints" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSet.json"
}
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"disabled" : {
"type" : "boolean"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"externalAuth" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"invitation" : {
"type" : "boolean"
},
"lastLogin" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"ldapId" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"openId" : {
"type" : "string"
},
"password" : {
"type" : "string",
"writeOnly" : true
},
"passwordLastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"publicAccess" : {
"type" : "string"
},
"selfRegistered" : {
"type" : "boolean"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"twoFA" : {
"type" : "boolean"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userInfo" : {
"$ref" : "user.json"
},
"userRoles" : {
"type" : "array",
"items" : {
"$ref" : "userAuthorityGroup.json"
}
},
"username" : {
"type" : "string"
}
}
}
userGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"managedByGroups" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"managedGroups" : {
"type" : "array",
"items" : {
"$ref" : "#"
}
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
userGroupAccess
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"userGroupUid" : {
"type" : "string"
},
"displayName()" : {
"type" : "string"
}
}
}
userInvitationStatus
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "NONE", "ALL", "EXPIRED" ]
}
userSettingKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "STYLE", "MESSAGE_EMAIL_NOTIFICATION", "MESSAGE_SMS_NOTIFICATION", "UI_LOCALE", "DB_LOCALE", "ANALYSIS_DISPLAY_PROPERTY", "TRACKER_DASHBOARD_LAYOUT" ]
}
users
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"users" : {
"type" : "array",
"items" : {
"$ref" : "user.json"
}
}
}
}
sharing
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"external" : {
"type" : "boolean"
},
"owner" : {
"type" : "string"
},
"public" : {
"type" : "string"
},
"userGroups" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "userGroupAccess_.json"
}
},
"users" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "userAccess_.json"
}
}
}
}
sharingBuilder
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"external(boolean)" : {
"$ref" : "#"
},
"owner(String)" : {
"$ref" : "#"
},
"public(String)" : {
"$ref" : "#"
},
"userGroups(Map<String, UserGroupAccess>)" : {
"$ref" : "#"
},
"users(Map<String, UserAccess>)" : {
"$ref" : "#"
}
}
}
userAccess_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
userGroupAccess_
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"type" : "string"
},
"id" : {
"type" : "string"
}
}
}
userKeyJsonValue
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"value" : {
"type" : "string"
}
}
}
importance
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "HIGH", "MEDIUM", "LOW" ]
}
validationResult
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"attributeOptionCombo" : {
"$ref" : "categoryOptionCombo.json"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"dayInPeriod" : {
"type" : "integer"
},
"id" : {
"type" : "integer"
},
"leftsideValue" : {
"type" : "number"
},
"notificationSent" : {
"type" : "boolean"
},
"organisationUnit" : {
"$ref" : "organisationUnit.json"
},
"period" : {
"$ref" : "period.json"
},
"rightsideValue" : {
"type" : "number"
},
"validationRule" : {
"$ref" : "validationRule.json"
}
}
}
validationRule
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregateExportAttributeOptionCombo" : {
"type" : "string"
},
"aggregateExportCategoryOptionCombo" : {
"type" : "string"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"dimensionItem" : {
"type" : "string"
},
"dimensionItemType" : {
"$ref" : "dimensionItemType.json"
},
"displayDescription" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayInstruction" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"formName" : {
"type" : "string"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"importance" : {
"$ref" : "importance.json"
},
"instruction" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"leftSide" : {
"$ref" : "expression.json"
},
"legendSet" : {
"$ref" : "legendSet.json"
},
"legendSets" : {
"type" : "array",
"items" : {
"$ref" : "legendSet.json"
}
},
"name" : {
"type" : "string"
},
"notificationTemplates" : {
"type" : "array",
"items" : {
"$ref" : "validationNotificationTemplate.json"
}
},
"operator" : {
"$ref" : "operator.json"
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"periodOffset" : {
"type" : "integer"
},
"periodType" : {
"$ref" : "periodType.json"
},
"publicAccess" : {
"type" : "string"
},
"rightSide" : {
"$ref" : "expression.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"skipFormValidation" : {
"type" : "boolean"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRuleGroups" : {
"type" : "array",
"items" : {
"$ref" : "validationRuleGroup.json"
}
}
}
}
validationRuleGroup
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"description" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
validationRunType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "INTERACTIVE", "SCHEDULED" ]
}
validationSummary
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"commentRequiredViolations" : {
"type" : "array",
"items" : {
"$ref" : "dataElementOperand.json"
}
},
"validationRuleViolations" : {
"type" : "array",
"items" : {
"$ref" : "validationResult.json"
}
}
}
}
validationNotificationTemplate
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayMessageTemplate" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displaySubjectTemplate" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"messageTemplate" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"notifyParentOrganisationUnitOnly" : {
"type" : "boolean"
},
"notifyUsersInHierarchyOnly" : {
"type" : "boolean"
},
"publicAccess" : {
"type" : "string"
},
"recipientUserGroups" : {
"type" : "array",
"items" : {
"$ref" : "userGroup.json"
}
},
"sendStrategy" : {
"$ref" : "sendStrategy.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"subjectTemplate" : {
"type" : "string"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"validationRules" : {
"type" : "array",
"items" : {
"$ref" : "validationRule.json"
}
}
}
}
validationRuleTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RULE_NAME", "DESCRIPTION", "OPERATOR", "IMPORTANCE", "LEFT_SIDE_DESCRIPTION", "RIGHT_SIDE_DESCRIPTION", "LEFT_SIDE_VALUE", "RIGHT_SIDE_VALUE", "ORG_UNIT_NAME", "PERIOD", "CURRENT_DATE" ]
}
validationRuleTemplateVariable
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "RULE_NAME", "DESCRIPTION", "OPERATOR", "IMPORTANCE", "LEFT_SIDE_DESCRIPTION", "RIGHT_SIDE_DESCRIPTION", "LEFT_SIDE_VALUE", "RIGHT_SIDE_VALUE", "ORG_UNIT_NAME", "PERIOD", "CURRENT_DATE" ]
}
axis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"axis" : {
"type" : "integer"
},
"dimensionalItem" : {
"type" : "string"
}
}
}
axisType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "DOMAIN", "RANGE" ]
}
axisV2
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"baseLine" : {
"$ref" : "line.json"
},
"decimals" : {
"type" : "integer"
},
"index" : {
"type" : "integer"
},
"label" : {
"$ref" : "styledObject.json"
},
"maxValue" : {
"type" : "integer"
},
"minValue" : {
"type" : "integer"
},
"steps" : {
"type" : "integer"
},
"targetLine" : {
"$ref" : "line.json"
},
"title" : {
"$ref" : "styledObject.json"
},
"type" : {
"$ref" : "axisType.json"
}
}
}
legendDefinitions
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"set" : {
"$ref" : "legendSet.json"
},
"showKey" : {
"type" : "boolean"
},
"strategy" : {
"$ref" : "legendDisplayStrategy.json"
},
"style" : {
"$ref" : "legendDisplayStyle.json"
}
}
}
line
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"title" : {
"$ref" : "styledObject.json"
},
"value" : {
"type" : "integer"
}
}
}
normalizedOutlierMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"const" : "Y_RESIDUALS_LINEAR"
}
outlierAnalysis
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"extremeLines" : {
"$ref" : "outlierLine.json"
},
"normalizationMethod" : {
"$ref" : "normalizedOutlierMethod.json"
},
"outlierMethod" : {
"$ref" : "outlierMethod.json"
},
"thresholdFactor" : {
"type" : "number"
}
}
}
outlierLine
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"enabled" : {
"type" : "boolean"
},
"value" : {
"type" : "number"
}
}
}
outlierMethod
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "IQR", "STANDARD_Z_SCORE", "MODIFIED_Z_SCORE" ]
}
reportingParams
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"grandParentOrganisationUnit" : {
"type" : "boolean"
},
"organisationUnit" : {
"type" : "boolean"
},
"parentOrganisationUnit" : {
"type" : "boolean"
},
"reportingPeriod" : {
"type" : "boolean"
}
}
}
series
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"axis" : {
"type" : "integer"
},
"dimensionItem" : {
"type" : "string"
},
"type" : {
"$ref" : "visualizationType.json"
}
}
}
seriesKey
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"hidden" : {
"type" : "boolean"
},
"label" : {
"$ref" : "styledObject.json"
}
}
}
simpleVisualizationView
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"code" : {
"type" : "string"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"displayName" : {
"type" : "string"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"name" : {
"type" : "string"
},
"publicAccess" : {
"type" : "string"
},
"sharing" : {
"$ref" : "sharing.json"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
}
}
}
styledObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"fontStyle" : {
"$ref" : "fontStyle.json"
},
"text" : {
"type" : "string"
},
"textMode" : {
"$ref" : "textMode.json"
}
}
}
textMode
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "AUTO", "CUSTOM" ]
}
visualization
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"access" : {
"$ref" : "access.json"
},
"aggregationType" : {
"$ref" : "aggregationType.json"
},
"attributeDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityAttributeDimension.json"
}
},
"attributeValues" : {
"type" : "array",
"items" : {
"$ref" : "attributeValue.json"
}
},
"axes" : {
"type" : "array",
"items" : {
"$ref" : "axisV2.json"
}
},
"baseLineLabel" : {
"type" : "string",
"readOnly" : true
},
"baseLineValue" : {
"type" : "number",
"readOnly" : true
},
"categoryDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryDimension.json"
}
},
"categoryOptionGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "categoryOptionGroupSetDimension.json"
}
},
"code" : {
"type" : "string"
},
"colSubTotals" : {
"type" : "boolean"
},
"colTotals" : {
"type" : "boolean"
},
"colorSet" : {
"type" : "string"
},
"columnDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"completedOnly" : {
"type" : "boolean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"createdBy" : {
"$ref" : "user.json"
},
"cumulativeValues" : {
"type" : "boolean"
},
"dataDimensionItems" : {
"type" : "array",
"items" : {
"$ref" : "dataDimensionItem.json"
}
},
"dataElementDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityDataElementDimension.json"
}
},
"dataElementGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "dataElementGroupSetDimension.json"
}
},
"description" : {
"type" : "string"
},
"digitGroupSeparator" : {
"$ref" : "digitGroupSeparator.json"
},
"displayBaseLineLabel" : {
"type" : "string"
},
"displayDensity" : {
"$ref" : "displayDensity.json"
},
"displayDescription" : {
"type" : "string"
},
"displayDomainAxisLabel" : {
"type" : "string"
},
"displayFormName" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"displayRangeAxisLabel" : {
"type" : "string"
},
"displayShortName" : {
"type" : "string"
},
"displaySubtitle" : {
"type" : "string"
},
"displayTargetLineLabel" : {
"type" : "string"
},
"displayTitle" : {
"type" : "string"
},
"domainAxisLabel" : {
"type" : "string",
"readOnly" : true
},
"endDate" : {
"type" : "string",
"format" : "date-time"
},
"externalAccess" : {
"type" : "boolean"
},
"favorite" : {
"type" : "boolean"
},
"favorites" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filterDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"fixColumnHeaders" : {
"type" : "boolean"
},
"fixRowHeaders" : {
"type" : "boolean"
},
"fontSize" : {
"$ref" : "fontSize.json"
},
"fontStyle" : {
"$ref" : "visualizationFontStyle.json"
},
"formName" : {
"type" : "string"
},
"hideEmptyColumns" : {
"type" : "boolean"
},
"hideEmptyRowItems" : {
"$ref" : "hideEmptyItemStrategy.json"
},
"hideEmptyRows" : {
"type" : "boolean"
},
"hideLegend" : {
"type" : "boolean"
},
"hideSubtitle" : {
"type" : "boolean"
},
"hideTitle" : {
"type" : "boolean"
},
"href" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"interpretations" : {
"type" : "array",
"items" : {
"$ref" : "interpretation.json"
}
},
"itemOrganisationUnitGroups" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroup.json"
}
},
"lastUpdated" : {
"type" : "string",
"format" : "date-time"
},
"lastUpdatedBy" : {
"$ref" : "user.json"
},
"legend" : {
"$ref" : "legendDefinitions.json"
},
"measureCriteria" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"noSpaceBetweenColumns" : {
"type" : "boolean"
},
"numberType" : {
"$ref" : "numberType.json"
},
"optionalAxes" : {
"type" : "array",
"items" : {
"$ref" : "axis.json"
}
},
"orgUnitField" : {
"type" : "string"
},
"organisationUnitGroupSetDimensions" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnitGroupSetDimension.json"
}
},
"organisationUnitLevels" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"organisationUnits" : {
"type" : "array",
"items" : {
"$ref" : "organisationUnit.json"
}
},
"outlierAnalysis" : {
"$ref" : "outlierAnalysis.json"
},
"parentGraphMap" : {
"type" : "object",
"readOnly" : true,
"additionalProperties" : {
"type" : "string"
}
},
"percentStackedValues" : {
"type" : "boolean"
},
"periods" : {
"type" : "array",
"items" : {
"$ref" : "period.json"
}
},
"programIndicatorDimensions" : {
"type" : "array",
"items" : {
"$ref" : "trackedEntityProgramIndicatorDimension.json"
}
},
"publicAccess" : {
"type" : "string"
},
"rangeAxisDecimals" : {
"type" : "integer",
"readOnly" : true
},
"rangeAxisLabel" : {
"type" : "string",
"readOnly" : true
},
"rangeAxisMaxValue" : {
"type" : "number",
"readOnly" : true
},
"rangeAxisMinValue" : {
"type" : "number",
"readOnly" : true
},
"rangeAxisSteps" : {
"type" : "integer",
"readOnly" : true
},
"regression" : {
"type" : "boolean"
},
"regressionType" : {
"$ref" : "regressionType.json"
},
"relativePeriods" : {
"$ref" : "relativePeriods.json"
},
"reportingParams" : {
"$ref" : "reportingParams.json"
},
"rowDimensions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"rowSubTotals" : {
"type" : "boolean"
},
"rowTotals" : {
"type" : "boolean"
},
"rows" : {
"type" : "array",
"items" : {
"$ref" : "dimensionalObject.json"
}
},
"series" : {
"type" : "array",
"items" : {
"$ref" : "series.json"
}
},
"seriesKey" : {
"$ref" : "seriesKey.json"
},
"sharing" : {
"$ref" : "sharing.json"
},
"shortName" : {
"type" : "string"
},
"showData" : {
"type" : "boolean"
},
"showDimensionLabels" : {
"type" : "boolean"
},
"showHierarchy" : {
"type" : "boolean"
},
"skipRounding" : {
"type" : "boolean"
},
"sortOrder" : {
"type" : "integer"
},
"startDate" : {
"type" : "string",
"format" : "date-time"
},
"subscribed" : {
"type" : "boolean"
},
"subscribers" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"subtitle" : {
"type" : "string"
},
"targetLineLabel" : {
"type" : "string",
"readOnly" : true
},
"targetLineValue" : {
"type" : "number",
"readOnly" : true
},
"timeField" : {
"type" : "string"
},
"title" : {
"type" : "string"
},
"topLimit" : {
"type" : "integer"
},
"translations" : {
"type" : "array",
"items" : {
"$ref" : "translation.json"
}
},
"type" : {
"$ref" : "visualizationType.json"
},
"user" : {
"$ref" : "user.json"
},
"userAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userAccess.json"
}
},
"userGroupAccesses" : {
"type" : "array",
"items" : {
"$ref" : "userGroupAccess.json"
}
},
"userOrgUnitType" : {
"$ref" : "userOrgUnitType.json"
},
"userOrganisationUnit" : {
"type" : "boolean"
},
"userOrganisationUnitChildren" : {
"type" : "boolean"
},
"userOrganisationUnitGrandChildren" : {
"type" : "boolean"
},
"visualizationPeriodName" : {
"type" : "string"
},
"yearlySeries" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
visualizationFontStyle
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object",
"properties" : {
"baseLineLabel" : {
"$ref" : "fontStyle.json"
},
"categoryAxisLabel" : {
"$ref" : "fontStyle.json"
},
"horizontalAxisTitle" : {
"$ref" : "fontStyle.json"
},
"legend" : {
"$ref" : "fontStyle.json"
},
"seriesAxisLabel" : {
"$ref" : "fontStyle.json"
},
"targetLineLabel" : {
"$ref" : "fontStyle.json"
},
"verticalAxisTitle" : {
"$ref" : "fontStyle.json"
},
"visualizationSubtitle" : {
"$ref" : "fontStyle.json"
},
"visualizationTitle" : {
"$ref" : "fontStyle.json"
}
}
}
visualizationType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "COLUMN", "STACKED_COLUMN", "BAR", "STACKED_BAR", "LINE", "AREA", "STACKED_AREA", "PIE", "RADAR", "GAUGE", "YEAR_OVER_YEAR_LINE", "YEAR_OVER_YEAR_COLUMN", "SINGLE_VALUE", "PIVOT_TABLE", "SCATTER", "BUBBLE" ]
}
sortDirection
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "ASC", "DESC", "IASC", "IDESC" ]
}
jsonNodeType
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "string",
"enum" : [ "OBJECT", "ARRAY", "STRING", "NUMBER", "BOOLEAN", "NULL" ]
}
geometry
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionalItemObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionalObject
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
dimensionItemKeywords
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"type" : "object"
}
